Skip to content

Latest commit

 

History

History
55 lines (39 loc) · 2.74 KB

CONTRIBUTING.md

File metadata and controls

55 lines (39 loc) · 2.74 KB
Raw

How to Contribute

We'd love to accept your patches and contributions to this project. There are just a few small guidelines you need to follow.

Discussion

Share your proposal via GitHub Issues. If you are looking for some issues to get started with, we have a list of good first issues in the issue tracker. We also welcome submissions to improve the documentation.

Pull Request

All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult GitHub Help for more information on using pull requests.

  1. In the pull request description, clearly document all changes made and the expected behavior.
  2. If you are introducing new functionality, add at least one unit test under the test folder and make sure it passes before you submit the pull request.
  3. Similarly, if you are fixing a bug, add at least one unit test under the test folder such that the master branch fails the test and your branch passes the test.
  4. Install and run pre-commit on the files that you have edited. We are adiabatically turning on linting for the full repository (see #678).
  5. Submit the pull request to the main branch.

Code Reviews

We will review your contribution and, if any additional fixes or modifications are necessary, may provide feedback to guide you. When accepted, your pull request will be merged to the repository.

Code of Conduct

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.

Our Standards

Examples of behavior that contributes to creating a positive environment include:

  • Using welcoming and inclusive language
  • Being respectful of differing viewpoints and experiences
  • Gracefully accepting constructive criticism
  • Focusing on what is best for the community
  • Showing empathy towards other community members

Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

For answers to common questions about this code of conduct, see https://www.contributor-covenant.org/faq