Browse Source

Create CONTRIBUTING.md

Lukáš Mešťan 6 years ago
parent
commit
c15e2d57da
1 changed files with 25 additions and 0 deletions
  1. 25
    0
      CONTRIBUTING.md

+ 25
- 0
CONTRIBUTING.md View File

@@ -0,0 +1,25 @@
1
+Contributing
2
+============
3
+
4
+Want to contribute? Great! First, read this page.
5
+
6
+# Code reviews
7
+All submissions, including submissions by project members, require review. We
8
+use Github pull requests for this purpose.
9
+
10
+# Some tips for good pull requests:
11
+* Use our code
12
+  When in doubt, try to stay true to the existing code of the project.
13
+* Write a descriptive commit message. What problem are you solving and what
14
+  are the consequences? Where and what did you test? Some good tips:
15
+  [here](http://robots.thoughtbot.com/5-useful-tips-for-a-better-commit-message)
16
+  and [here](https://www.kernel.org/doc/Documentation/SubmittingPatches).
17
+* If your PR consists of multiple commits which are successive improvements /
18
+  fixes to your first commit, consider squashing them into a single commit
19
+  (`git rebase -i`) such that your PR is a single commit on top of the current
20
+  HEAD. This make reviewing the code so much easier, and our history more
21
+  readable.
22
+
23
+# Formatting
24
+
25
+This documentation is written using standard [markdown syntax](https://help.github.com/articles/markdown-basics/). Please submit your changes using the same syntax.

Loading…
Cancel
Save