Skip to content

Latest commit

 

History

History
50 lines (32 loc) · 2.71 KB

CONTRIBUTING.md

File metadata and controls

50 lines (32 loc) · 2.71 KB

Contributing

Thanks for considering contributing to this project!

Reading and following these guidelines will help make the contribution process easy and effective for everyone involved. It also communicates that you agree to respect the time of the developers managing and developing this open source project.

Code of Conduct

By participating and contributing to this project, you agree to uphold our Code of Conduct.

Issues

Issues are very valuable to this project regarding various aspects:

  • Reporting issues with the project
  • Providing feedback on the project
  • Requesting a feature or improvement
  • Improving the documentation
  • Discussing potential changes to the project before a PR is created

Thank you for creating them. Please provide as much details as possible, including screenshots or sample code if necessary.

When opening a new issue, a template will be provided to you to guide you through collecting the information needed. If you find an issue already addressing the problem you're having, please add your own reproduction informations to the existing issue rather than creating a new one. Adding a reaction can also help be indicating that a particular problem is affecting more than just the reporter.

If you find a security vulnerability, do NOT open an issue. Email [email protected] instead.

Pull Requests

Pull Requests are a great way to propose changes to the codebase and are always welcome. Pull Requests should in general:

  • Address a single concern in the least number of changed lines as possible
  • Add unit or integration tests for the fixed or changed behavior (if a test suite already exists)
  • Update any existing documentation if needed
  • Be accompanied by a complete PR template that is provided to you when creating it

For feature Pull Request or large PRs, it is always better to open an issue to discuss your proposal first.

It is suggested to follow the Fork and Pull Request Workflow:

  1. Fork this repository to your own GitHub account
  2. Clone your fork to your machine
  3. Create a new branch locally
  4. Commit your changes to the branch
  5. Follow any formatting and testing guidelines specific to this project
  6. Push changes to your fork
  7. Open a PR in this repository and follow the PR template automatically provided to you

Working on your first Pull Request? You can learn how from this free video series on How to Contribute to an Open Source Project on GitHub.

By contributing, you agree that your contributions will be licensed under the same that covers this project.