1
1
# How to Contribute
2
2
3
- Pull requests are greatly appreciated and are what makes opensource great. Here's a quick guide:
3
+ We'd love to accept your patches and contributions to this project. Pull requests are part of
4
+ what makes open source great. There are just a few small guidelines you need to follow.
4
5
5
- * Fork it
6
- * Create your feature branch (` git checkout -b my-new-feature ` )
7
- * Commit your changes (` git commit -am 'Add some feature' ` )
8
- * Push to the branch (` git push origin my-new-feature ` )
9
- * Create new Pull Request
6
+ ## Code of Conduct
10
7
11
- Pester us if we don't get your Pull Requests merged in a timely fashion. :)
8
+ Participation in this project comes under the [ Contributor Covenant Code of Conduct] ( CODE_OF_CONDUCT.md )
9
+
10
+ ## Submitting code via Pull Requests
11
+
12
+ - We follow the [ Github Pull Request Model] ( https://help.github.com/articles/about-pull-requests/ ) for
13
+ all contributions.
14
+ - For large bodies of work, we recommend creating an issue outlining the feature that you wish to build,
15
+ and describing how it will be implemented. This gives a chance for review to happen early, and ensures
16
+ no wasted effort occurs.
17
+ - All submissions, will require review before being merged.
18
+ - Finally - * Thanks* for considering submitting code to the project!
19
+
20
+ ## Formatting
21
+
22
+ When submitting pull requests, make sure to do the following:
23
+
24
+ - Maintain the same code style as the rest of the project.
25
+ - Remove trailing whitespace. Many editors will do this automatically.
26
+ - Ensure any new files have [ a trailing newline] ( https://stackoverflow.com/questions/5813311/no-newline-at-end-of-file )
12
27
13
28
## How to speed the merging of pull requests
14
29
15
- * Describe your changes in the CHANGELOG.
16
- * Give yourself some credit in the appropriate place (usually the CHANGELOG).
30
+ * Describe your changes in the CHANGELOG.md (if present).
31
+ * Give yourself some credit in the appropriate place (usually the CHANGELOG.md ).
17
32
* Make commits of logical units.
18
33
* Ensure your commit messages help others understand what you are doing and why.
19
34
* Check for unnecessary whitespace with ` git diff --check ` before committing.
@@ -23,4 +38,6 @@ Pester us if we don't get your Pull Requests merged in a timely fashion. :)
23
38
## Additional Resources
24
39
25
40
* [ General GitHub documentation] ( http://help.github.com/ )
26
- * [ GitHub pull request documentation] ( http://help.github.com/send-pull-requests/ )
41
+ * [ How to write a good Git Commit message] ( https://chris.beams.io/posts/git-commit/ ) -
42
+ Great way to make sure your Pull Requests get accepted.
43
+ * [ An Open Source Etiquette Guidebook] ( https://css-tricks.com/open-source-etiquette-guidebook/#article-header-id-1 )
0 commit comments