Skip to content

Commit f74ae86

Browse files
committed
Add contributing information.
To help people who wish to contribute to this repo the contributing file gives out clear information on our values and how to match those expectations.
1 parent d289da8 commit f74ae86

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

.github/.CONTRIBUTING

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Contributing
2+
3+
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:
4+
5+
- Your changes are covered in by the tests, run `make qa` to lint and test your changes.
6+
- Your changes are reflected in the README or any other docs that are relevant.
7+
- Once you are ready to make your commits, ensure they are:
8+
- atomic, meaning they focus on a single set of changes
9+
- the commit message is clear, we suggest [this standard](https://chris.beams.io/posts/git-commit/).
10+
- Follow our PR template when opening the PR.
11+
12+
Thank you for contributing!

0 commit comments

Comments
 (0)