Skip to content

Commit 7481116

Browse files
committed
add CONTRIBUTING.md
1 parent be2f336 commit 7481116

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

CONTRIBUTING.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Contributing
2+
3+
First off, thanks for taking the time to contribute!
4+
5+
## Steps to Contribute
6+
7+
This project uses GitHub to manage reviews of pull requests.
8+
9+
* If you have a trivial fix or improvement, go ahead and create a pull request
10+
11+
* If you plan to do something more involved, first create an issue to discuss your ideas
12+
13+
* Should you wish to work on an issue, please claim it first by commenting on the GitHub issue that you want to work on it. This is to prevent duplicated efforts from contributors on the same issue.
14+
15+
## Pull Request Checklist
16+
17+
* Start by forking the project, and then create a feature branch from the master branch for your feature.
18+
19+
* If needed, rebase to the current master branch before submitting your pull request. If it doesn't merge cleanly with master you may be asked to rebase your changes.
20+
21+
* Commits should be as small as possible, while ensuring that each commit is correct independently (i.e., each commit should compile and pass tests).
22+
23+
* Add tests relevant to the fixed bug or new feature.

0 commit comments

Comments
 (0)