Skip to content

Commit de415fc

Browse files
authored
Merge pull request #13 from Neilblaze/master
Added CONTRIBUTING.md
2 parents 4539a1a + 8acdfa4 commit de415fc

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

CONTRIBUTING.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
## Contributions Best Practices
2+
3+
**Commits**
4+
* Write clear meaningful git commit messages.
5+
* Make sure your PR's description contains GitHub's special keyword references that automatically close the related issue when the PR is merged.
6+
* When you make very very minor changes to a PR of yours make sure you squash your commits afterwards so that you don't have an absurd number of commits for a very small fix.
7+
* When you're submitting a PR for a UI-related issue, it would be really awesome if you add a screenshot of your change or a link to a deployment where it can be tested out along with your PR. It makes it very easy for the reviewers and you'll also get reviews quicker.
8+
* If you are creating a issue, it would be awesome if you could add logs or crash reports as well as steps to reproduce it.
9+
10+
11+
**Join the development**
12+
* Before you join development, please set up the project on your local machine, run it and go through the application completely. Press on any button you can find and see where it leads to. Explore!
13+
* If you would like to work on an issue, drop in a comment at the issue. If it is already assigned to someone, but there is no sign of any work being done, please free to drop in a comment so that the issue can be assigned to you if the previous assignee has dropped it entirely.

0 commit comments

Comments
 (0)