-
Notifications
You must be signed in to change notification settings - Fork 57
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #17 from rdohms/enhancement/contributing-info
Add contributing information.
- Loading branch information
Showing
1 changed file
with
12 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,12 @@ | ||
# Contributing | ||
|
||
Quick set of guideline to contribute to this repo. After you have checked out the code and are ready to send in your PR, just make sure you are following these steps: | ||
|
||
- Your changes are covered in by the tests, run `make qa` to lint and test your changes. | ||
- Your changes are reflected in the README or any other docs that are relevant. | ||
- Once you are ready to make your commits, ensure they are: | ||
- atomic, meaning they focus on a single set of changes | ||
- the commit message is clear, we suggest [this standard](https://chris.beams.io/posts/git-commit/). | ||
- Follow our PR template when opening the PR. | ||
|
||
Thank you for contributing! |