|
| 1 | +## Making Changes |
| 2 | + |
| 3 | +* Create a topic branch from where you want to base your work. |
| 4 | + * This is usually the master branch. |
| 5 | + * Only target release branches if you are certain your fix must be on that |
| 6 | + branch. |
| 7 | + * To quickly create a topic branch based on master; `git checkout -b |
| 8 | + fix/master/my_contribution master`. Please avoid working directly on the |
| 9 | + `master` branch. |
| 10 | +* Make commits of logical units. |
| 11 | +* Check for unnecessary whitespace with `git diff --check` before committing. |
| 12 | +* Make sure your commit messages are in the proper format. |
| 13 | + |
| 14 | +```` |
| 15 | + Make the example in CONTRIBUTING imperative and concrete |
| 16 | +
|
| 17 | + Without this patch applied the example commit message in the CONTRIBUTING |
| 18 | + document is not a concrete example. This is a problem because the |
| 19 | + contributor is left to imagine what the commit message should look like |
| 20 | + based on a description rather than an example. This patch fixes the |
| 21 | + problem by making the example concrete and imperative. |
| 22 | +
|
| 23 | + The first line is a real life imperative statement with a ticket number |
| 24 | + from our issue tracker. The body describes the behavior without the patch, |
| 25 | + why this is a problem, and how the patch fixes the problem when applied. |
| 26 | +```` |
| 27 | + |
| 28 | +* Make sure you have added the necessary tests for your changes. |
| 29 | +* Run _all_ the tests to assure nothing else was accidentally broken. |
| 30 | + |
| 31 | +## Making Trivial Changes |
| 32 | + |
| 33 | +### Documentation |
| 34 | + |
| 35 | +For changes of a trivial nature to comments and documentation, it is not |
| 36 | +always necessary to create a new ticket in Jira. In this case, it is |
| 37 | +appropriate to start the first line of a commit with '(doc)' instead of |
| 38 | +a ticket number. |
| 39 | + |
| 40 | +```` |
| 41 | + (doc) Add documentation commit example to CONTRIBUTING |
| 42 | +
|
| 43 | + There is no example for contributing a documentation commit |
| 44 | + to the Puppet repository. This is a problem because the contributor |
| 45 | + is left to assume how a commit of this nature may appear. |
| 46 | +
|
| 47 | + The first line is a real life imperative statement with '(doc)' in |
| 48 | + place of what would have been the ticket number in a |
| 49 | + non-documentation related commit. The body describes the nature of |
| 50 | + the new documentation or comments added. |
| 51 | +```` |
| 52 | + |
| 53 | +## Submitting Changes |
| 54 | + |
| 55 | +* Push your changes to a topic branch in your fork of the repository. |
| 56 | +* Submit a pull request to the repository in the puppetlabs organization. |
| 57 | +* We will try our best to give timely feedback on PRs |
0 commit comments