You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
*[Writing proper commits - short version](#writing-proper-commits-short-version)
7
+
*[Writing proper commits - long version](#writing-proper-commits-long-version)
8
+
*[Dependencies](#dependencies)
9
+
*[Note for OS X users](#note-for-os-x-users)
10
+
*[The test matrix](#the-test-matrix)
11
+
*[Syntax and style](#syntax-and-style)
12
+
*[Running the unit tests](#running-the-unit-tests)
13
+
*[Unit tests in docker](#unit-tests-in-docker)
14
+
*[Integration tests](#integration-tests)
15
+
1
16
This module has grown over time based on a range of contributions from
2
17
people using it. If you follow these contributing guidelines your patch
3
18
will likely make it into a release a little more quickly.
@@ -8,29 +23,92 @@ Please note that this project is released with a Contributor Code of Conduct.
8
23
By participating in this project you agree to abide by its terms.
9
24
[Contributor Code of Conduct](https://voxpupuli.org/coc/).
10
25
11
-
1. Fork the repo.
12
-
13
-
1. Create a separate branch for your change.
14
-
15
-
1. We only take pull requests with passing tests, and documentation. [travis-ci](http://travis-ci.org)
16
-
runs the tests for us. You can also execute them locally. This is explained
17
-
in a later section.
18
-
19
-
1. Checkout [our docs](https://voxpupuli.org/docs/#reviewing-a-module-pr) we
20
-
use to review a module and the [official styleguide](https://puppet.com/docs/puppet/6.0/style_guide.html).
21
-
They provide some guidance for new code that might help you before you submit a pull request.
22
-
23
-
1. Add a test for your change. Only refactoring and documentation
24
-
changes require no new tests. If you are adding functionality
25
-
or fixing a bug, please add a test.
26
-
27
-
1. Squash your commits down into logical components. Make sure to rebase
28
-
against our current master.
29
-
30
-
1. Push the branch to your fork and submit a pull request.
31
-
32
-
Please be prepared to repeat some of these steps as our contributors review
33
-
your code.
26
+
* Fork the repo.
27
+
* Create a separate branch for your change.
28
+
* We only take pull requests with passing tests, and documentation. [travis-ci](http://travis-ci.org) runs the tests for us. You can also execute them locally. This is explained [in a later section](#the-test-matrix).
29
+
* Checkout [our docs](https://voxpupuli.org/docs/reviewing_pr/) we use to review a module and the [official styleguide](https://puppet.com/docs/puppet/6.0/style_guide.html). They provide some guidance for new code that might help you before you submit a pull request.
30
+
* Add a test for your change. Only refactoring and documentation changes require no new tests. If you are adding functionality or fixing a bug, please add a test.
31
+
* Squash your commits down into logical components. Make sure to rebase against our current master.
32
+
* Push the branch to your fork and submit a pull request.
33
+
34
+
Please be prepared to repeat some of these steps as our contributors review your code.
35
+
36
+
## Writing proper commits - short version
37
+
38
+
* Make commits of logical units.
39
+
* Check for unnecessary whitespace with "git diff --check" before committing.
40
+
* Commit using Unix line endings (check the settings around "crlf" in git-config(1)).
41
+
* Do not check in commented out code or unneeded files.
42
+
* The first line of the commit message should be a short description (50 characters is the soft limit, excluding ticket number(s)), and should skip the full stop.
43
+
* Associate the issue in the message. The first line should include the issue number in the form "(#XXXX) Rest of message".
44
+
* The body should provide a meaningful commit message, which:
45
+
*uses the imperative, present tense: `change`, not `changed` or `changes`.
46
+
* includes motivation for the change, and contrasts its implementation with the previous behavior.
47
+
* Make sure that you have tests for the bug you are fixing, or feature you are adding.
48
+
* Make sure the test suites passes after your commit:
49
+
* When introducing a new feature, make sure it is properly documented in the README.md
50
+
51
+
## Writing proper commits - long version
52
+
53
+
1. Make separate commits for logically separate changes.
54
+
55
+
Please break your commits down into logically consistent units
56
+
which include new or changed tests relevant to the rest of the
57
+
change. The goal of doing this is to make the diff easier to
58
+
read for whoever is reviewing your code. In general, the easier
59
+
your diff is to read, the more likely someone will be happy to
60
+
review it and get it into the code base.
61
+
62
+
If you are going to refactor a piece of code, please do so as a
63
+
separate commit from your feature or bug fix changes.
64
+
65
+
We also really appreciate changes that include tests to make
66
+
sure the bug is not re-introduced, and that the feature is not
67
+
accidentally broken.
68
+
69
+
Describe the technical detail of the change(s). If your
70
+
description starts to get too long, that is a good sign that you
71
+
probably need to split up your commit into more finely grained
72
+
pieces.
73
+
74
+
Commits which plainly describe the things which help
75
+
reviewers check the patch and future developers understand the
76
+
code are much more likely to be merged in with a minimum of
77
+
bike-shedding or requested changes. Ideally, the commit message
78
+
would include information, and be in a form suitable for
79
+
inclusion in the release notes for the version of Puppet that
80
+
includes them.
81
+
82
+
Please also check that you are not introducing any trailing
83
+
whitespace or other "whitespace errors". You can do this by
84
+
running "git diff --check" on your changes before you commit.
85
+
86
+
2. Sending your patches
87
+
88
+
To submit your changes via a GitHub pull request, we _highly_
89
+
recommend that you have them on a topic branch, instead of
90
+
directly on `master`.
91
+
It makes things much easier to keep track of, especially if
92
+
you decide to work on another thing before your first change
93
+
is merged in.
94
+
95
+
GitHub has some pretty good
96
+
[general documentation](http://help.github.com/) on using
0 commit comments