Skip to content

Commit 7b4039a

Browse files
authored
Create CONTRIBUTING.md
1 parent e30f168 commit 7b4039a

File tree

1 file changed

+59
-0
lines changed

1 file changed

+59
-0
lines changed

CONTRIBUTING.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
How to contribute
2+
=================
3+
4+
We love pull requests. Here's a quick guide:
5+
6+
Getting Started
7+
---------------
8+
9+
- Make sure you have a [GitHub account](https://github.com/signup/free)
10+
- Submit a ticket for your issue, assuming one does not already exist.
11+
- Clearly describe the issue including steps to reproduce when it is a bug.
12+
- Make sure you fill in the earliest version that you know has the issue.
13+
- Fork the repository on GitHub
14+
15+
Making Changes
16+
--------------
17+
18+
- Create a topic branch from where you want to base your work.
19+
- This is usually the master branch.
20+
- Only target release branches if you are certain your fix must be on
21+
that branch.
22+
- To quickly create a topic branch based on master;
23+
``git branch fix/master/my_contribution master`` then checkout
24+
the new branch with ``git checkout fix/master/my_contribution``.
25+
Please avoid working directly on the ``master`` branch.
26+
- Make commits of logical units.
27+
- Check for unnecessary whitespace with ``git diff --check`` before
28+
committing.
29+
- Make sure your commit messages are in the proper format.
30+
31+
32+
Make the example in CONTRIBUTING imperative and concrete
33+
34+
Without this patch applied the example commit message in the CONTRIBUTING
35+
document is not a concrete example. This is a problem because the
36+
contributor is left to imagine what the commit message should look like
37+
based on a description rather than an example. This patch fixes the
38+
problem by making the example concrete and imperative.
39+
40+
The first line is a real life imperative statement with a ticket number
41+
from our issue tracker. The body describes the behavior without the patch,
42+
why this is a problem, and how the patch fixes the problem when applied.
43+
44+
45+
- Make sure you have added the necessary tests for your changes.
46+
- Run *all* the tests to assure nothing else was accidentally broken.
47+
48+
Submitting Changes
49+
------------------
50+
51+
- Push your changes to a topic branch in your fork of the repository.
52+
- Submit a pull request to the repository.
53+
54+
Additional Resources
55+
====================
56+
57+
- [General GitHub documentation](https://help.github.com)
58+
- [GitHub pull request
59+
documentation](https://help.github.com/articles/about-pull-requests)

0 commit comments

Comments
 (0)