-
Notifications
You must be signed in to change notification settings - Fork 129
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add instructions to contribute to project
- Loading branch information
Showing
2 changed files
with
40 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
# Contributing | ||
|
||
This project accepts community contributions. In order to contribute, please: | ||
|
||
1. Follow the coding style guidelines below | ||
2. Agree to the Developer Certificate of Origin | ||
3. Submit a GitHub pull request (PR) for review | ||
|
||
## Coding Style | ||
|
||
Please make sure to run [Black](https://black.readthedocs.io/en/stable/index.html) | ||
and [Flake8](https://flake8.pycqa.org/en/latest/) before submitting a PR. | ||
|
||
## Developer Certificate of Origin | ||
|
||
By contributing a PR to this project you agree to the [Developer Certificate of Origin (DCO)](https://developercertificate.org/). | ||
|
||
In short, you agree that you can make the contribution and that the project has | ||
the right to distribute your contribution under the terms of the project's | ||
[LICENSE](LICENSE). The PR itself is a sign-off of your agreement to the DCO. | ||
|
||
## Submission | ||
|
||
Submit a PR against the `main` branch. Please include one of the following | ||
prefixes in your commit messages so the [CHANGELOG](CHANGELOG.md) can be updated | ||
automatically: | ||
|
||
* `feat:` Adds a new feature | ||
* `fix:` Fixes a bug in the code | ||
* `refactor:` Restructures the code without changing its external behavior | ||
* `docs:` Documentation only changes | ||
* `test:` Adds or modifies tests | ||
* `style:` Changes to whitespace, formatting, etc; no code changes | ||
* `chore:` Changes to the build process or auxiliary tools |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters