Skip to content

Commit

Permalink
add CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jcarbaugh committed Jul 22, 2024
1 parent 2f1c936 commit a618d84
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Contributing to python-us

Thanks for your interesting in contributing to the project!

Before spending time working on a pull request, please [open an idea discussion](https://github.com/unitedstates/python-us/discussions/new?category=ideas) so we can ensure the change is in line with the goals of the project. Once you've got the go ahead, open a PR with your changes and reference the discussion in the description of the PR.

To speed up the review process, please ensure:

* your change has corresponding tests that run with the existing pytest suite and pass.
* the code is formatted with [black](https://black.readthedocs.io/en/stable/index.html), included in the dev dependencies.
* you are open to feedback!

Thank you and we look forward to your contribution! ✨

0 comments on commit a618d84

Please sign in to comment.