|
0 |
# How to contribute
|
|
1 |
|
|
2 |
* Make sure you have a [GitHub account](https://github.com/signup/free)
|
|
3 |
* Fork the repository on GitHub
|
|
4 |
|
|
5 |
## Making Changes
|
|
6 |
|
|
7 |
* Create a topic branch from where you want to base your work (this is almost
|
|
8 |
definitely the master branch).
|
|
9 |
* To quickly create a topic branch based on master; `git branch
|
|
10 |
fix/master/my_contribution master` then checkout the new branch with `git
|
|
11 |
checkout fix/master/my_contribution`.
|
|
12 |
* Please avoid working directly on the
|
|
13 |
`master` branch.
|
|
14 |
* Make commits of logical units.
|
|
15 |
* Check for unnecessary whitespace with `git diff --check` before committing.
|
|
16 |
* Make sure your commit messages are in the proper format.
|
|
17 |
|
|
18 |
````
|
|
19 |
Make the example in CONTRIBUTING imperative and concrete
|
|
20 |
|
|
21 |
Without this patch applied the example commit message in the CONTRIBUTING
|
|
22 |
document is not a concrete example. This is a problem because the
|
|
23 |
contributor is left to imagine what the commit message should look like
|
|
24 |
based on a description rather than an example. This patch fixes the
|
|
25 |
problem by making the example concrete and imperative.
|
|
26 |
|
|
27 |
The first line is a real life imperative statement with a ticket number
|
|
28 |
from our issue tracker. The body describes the behavior without the patch,
|
|
29 |
why this is a problem, and how the patch fixes the problem when applied.
|
|
30 |
````
|
|
31 |
|
|
32 |
* Make sure you have added the necessary tests for your changes.
|
|
33 |
* Run _all_ the tests to assure nothing else was accidentally broken.
|
|
34 |
|
|
35 |
## Submitting Changes
|
|
36 |
|
|
37 |
* Sign the [Contributor License Agreement](http://links.puppetlabs.com/cla).
|
|
38 |
* Push your changes to a topic branch in your fork of the repository.
|
|
39 |
* Submit a pull request to the repository in the puppetlabs organization.
|
|
40 |
|
|
41 |
# Additional Resources
|
|
42 |
|
|
43 |
* [Contributor License Agreement](http://links.puppetlabs.com/cla)
|
|
44 |
* [General GitHub documentation](http://help.github.com/)
|
|
45 |
* [GitHub pull request documentation](http://help.github.com/send-pull-requests/)
|
|
46 |
|