Skip to content

Commit 3dabd07

Browse files
authored
Merge pull request #176 from bastelfreak/reviews2
add a dedicated section about approvals and merges
2 parents 4b3a9bd + 4af5130 commit 3dabd07

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

docs/index.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -157,8 +157,6 @@ There are a few things that can be checked if you review a pull request against
157157
* Is a new template added? The preferred language is [epp](https://puppet.com/docs/puppet/latest/lang_template_epp.html), not [erb](https://puppet.com/docs/puppet/latest/lang_template_erb.html)
158158
* Is a new class added? It should have unit tests using [rpsec-puppet-facts](https://github.com/mcanevet/rspec-puppet-facts#rspec-puppet-facts) that at least verify that the new class compiles
159159
* Files should always terminate with a newline if possible, with an exception being file or template fragments like those used with concat. This is the [POSIX standard](http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap03.html#tag_03_206), and some tools don't handle the lack of a terminating newline properly
160-
* You can merge your own PR if it was approved by someone else and travis is green. Don't merge if either one of those conditions are not true
161-
* It's okay to approve code regardless if travis is still running or not. The code won't be merged if travis fails after the PR got approved
162160
* If you can supply one or multiple values for an attribute it's common practice to enforce the datatype for one value and an array of that datatype. An example for string is `Variant[String[1],Array[String[1]]]`. This can be used in the Puppet code as `[$var].flatten()`
163161
* The parameter section should always be aligned at the `=` char
164162
* Is a class considered private? Then it should contain [assert_private](https://github.com/puppetlabs/puppetlabs-stdlib#assert_private)
@@ -168,6 +166,13 @@ There are a few things that can be checked if you review a pull request against
168166
* Ensure that the version range of any dependency doesn't include an unreleased major version (do not allow version 6.X of a dependency if the current version is 5.X)
169167
* An increase of an upper version boundary (of a module or Puppet itself) is only an enhancement if code adjustments were needed. Don't add the `enhancement` label if the only change is within the `metadata.json`. Ensure that `.fixtures.yml` doesn't pin a specific version.
170168

169+
170+
### Approving and Merging
171+
172+
* You can merge your own PR if it was approved by someone else and travis is green. Don't merge if either one of those conditions are not true
173+
* Modulesync PRs are an exception (a PR based on changes that the msync tool did, NOT PRs on [modulesync_config](https://github.com/voxpupuli/modulesync_config#modulesync-configs)). We agreed some time ago that it's ok to merge your own modulesync PR if travis is green, without separate approval. This is okay because changes to [modulesync_config](https://github.com/voxpupuli/modulesync_config#modulesync-configs) were reviewed and tested
174+
* It's okay to approve code regardless if travis is still running or not. The code won't be merged if travis fails after the PR got approved
175+
171176
## Project management committee
172177

173178
We defined a [governance document](https://github.com/voxpupuli/plumbing/blob/master/share/governance.md#vox-pupuli-governance)

0 commit comments

Comments
 (0)