Skip to content

Commit d2f8f5a

Browse files
committed
Add contributing guidelines
1 parent 9032630 commit d2f8f5a

1 file changed

Lines changed: 29 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
### Coding style
2+
3+
Please adhere to the coding style throughout the project.
4+
5+
1. Always use tabs. [Here](https://leclan.ch/tabs) is a short explanation why tabs are preferred.
6+
2. Always use double quotes for strings, unless single quotes avoid unnecessary escapes.
7+
3. When in doubt, [PEP8](https://www.python.org/dev/peps/pep-0008/).
8+
4. Know when to make exceptions.
9+
10+
Also see: [How to name things in programming](http://www.slideshare.net/pirhilton/how-to-name-things-the-hardest-problem-in-programming)
11+
12+
13+
### Commits and Pull Requests
14+
15+
Keep the commit log as healthy as the code. It is one of the first places new contributors will look at the project.
16+
17+
1. No more than one change per commit. There should be no changes in a commit which are unrelated to its message.
18+
2. Every commit should pass all tests on its own.
19+
3. Follow [these conventions](http://chris.beams.io/posts/git-commit/) when writing the commit message
20+
21+
When filing a Pull Request, make sure it is rebased on top of most recent master.
22+
If you need to modify it or amend it in some way, you should always appropriately [fixup](https://help.github.com/articles/about-git-rebase/) the issues in git and force-push your changes to your fork.
23+
24+
Also see: [Github Help: Using Pull Requests](https://help.github.com/articles/using-pull-requests/)
25+
26+
27+
### Need help?
28+
29+
You can always ask for help in our IRC channel, `#Hearthsim` on [Freenode](https://freenode.net/).

0 commit comments

Comments
 (0)