Skip to content

Commit c88b396

Browse files
authored
Update CONTRIBUTING.md
1 parent 6f3036f commit c88b396

File tree

1 file changed

+48
-0
lines changed

1 file changed

+48
-0
lines changed

CONTRIBUTING.md

+48
Original file line numberDiff line numberDiff line change
@@ -1 +1,49 @@
1+
# Contributing
12

3+
We accept contributions of every kind: documentation, code, artwork. Any help is greatly
4+
appreciated. This document contains everything needed to get started with your first contribution.
5+
6+
7+
## Contributing Code
8+
9+
We keep the source code on [GitHub](https://www.github.com) and take contributions through
10+
[GitHub pull requests](https://help.github.com/articles/using-pull-requests).
11+
12+
For smaller patches and bug fixes just go ahead and either report an issue or submit a pull
13+
request.
14+
15+
It is usually a good idea to discuss major changes with the developers, this will help us
16+
determine whether the contribution would be a good fit for the project and if it is likely to be
17+
accepted. There's nothing worse than seeing your hard work being rejected because it falls outside
18+
of the scope of the project.
19+
20+
Make sure your editor respects the [EditorConfig](http://editorconfig.org) configuration file we
21+
put at the root of the repository.
22+
23+
We follow [GitHub Flow](http://scottchacon.com/2011/08/31/github-flow.html) as our git workflow of
24+
choice which boils down to:
25+
26+
* The `master` branch is always stable and deployable.
27+
* To work on something new, branch off `master` and give the new branch a descriptive name (e.g.:
28+
`sort-packages-by-name`, `issue-32`, etc).
29+
* Regularly __rebase__ that branch against `master` and push your work to a branch with the same
30+
name on the server.
31+
* When you need feedback, help or think you are ready,
32+
[submit a pull request](https://help.github.com/articles/using-pull-requests).
33+
* Once the branch has been merged (or rebased) into `master`, delete it from both your local and
34+
remote repository.
35+
36+
We invite you to follow
37+
[these guidelines](http://who-t.blogspot.de/2009/12/on-commit-messages.html) to write useful
38+
commit messages.
39+
40+
Additionally, you don't need to add entries to the [CHANGELOG.md](CHANGELOG.md) file, this is our
41+
responsibility.
42+
43+
44+
## Reading List
45+
46+
* [GitHub Flow](http://scottchacon.com/2011/08/31/github-flow.html)
47+
* [Keep a Changelog](http://keepachangelog.com/)
48+
* [On Commit Messages](http://who-t.blogspot.de/2009/12/on-commit-messages.html)
49+
* [Semantic Versioning](http://semver.org/)

0 commit comments

Comments
 (0)