Skip to content

Latest commit

 

History

History
47 lines (33 loc) · 2.18 KB

CONTRIBUTING.md

File metadata and controls

47 lines (33 loc) · 2.18 KB
Raw

Contributing

Hi there! We're excited that you'd like to contribute to this project. Your help is essential for keeping it awesome. Thank you very much!

Contributions to this project are released to the public under the project's open source license.

Please note that this project is released with a Collective Code Construction Contract. By participating in this project you agree to abide by its terms.

Submitting a feature request or bug report

If you find a bug or miss a feature feel free to submit a bug report or a feature request respectively in the GitHub issues.

The following few things will increase the likelihood of your bug report or feature request being processed in a timely manner:

  • Describe in a simple, easily to reproduce example how to reproduce the bug or what the feature request should do.
  • Mark it with the respective labels (bugs with "bug", features with "enhancement" and any other that apply).
  • Help us clarify the issue by answering our possible questions in a timely manner.

Submitting a pull request

  1. Fork and clone the repository
  2. Configure and install the dependencies: poetry install
  3. Make sure the tests pass on your machine: poetry run tox
  4. Make your change, add tests, and make sure the tests still pass
  5. Push to your fork and submit a pull request
  6. Pat your self on the back and wait for your pull request to be reviewed and merged

Here are a few things you can do that will increase the likelihood of your pull request being accepted:

  • Write tests and make them pass
  • Keep your change as focused as possible
  • If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests
  • Write a good and explanatory commit message

Resources