other/Puppet: modules/concat/CONTRIBUTING.md annotate

annotate modules/concat/CONTRIBUTING.md @ 36:37675581a273 puppet-3.6

Update Puppet module for Apache (pulls in concat module)

author	IBBoard <dev@ibboard.co.uk>
date	Sat, 14 Mar 2015 20:07:04 +0000
parents
children	d9352a684e62

rev	line source
36 37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	1 Checklist (and a short version for the impatient)
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	2 =================================================
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	3
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	4 * Commits:
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	5
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	6 - Make commits of logical units.
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	7
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	8 - Check for unnecessary whitespace with "git diff --check" before
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	9 committing.
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	10
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	11 - Commit using Unix line endings (check the settings around "crlf" in
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	12 git-config(1)).
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	13
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	14 - Do not check in commented out code or unneeded files.
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	15
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	16 - The first line of the commit message should be a short
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	17 description (50 characters is the soft limit, excluding ticket
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	18 number(s)), and should skip the full stop.
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	19
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	20 - Associate the issue in the message. The first line should include
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	21 the issue number in the form "(#XXXX) Rest of message".
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	22
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	23 - The body should provide a meaningful commit message, which:
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	24
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	25 - uses the imperative, present tense: "change", not "changed" or
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	26 "changes".
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	27
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	28 - includes motivation for the change, and contrasts its
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	29 implementation with the previous behavior.
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	30
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	31 - Make sure that you have tests for the bug you are fixing, or
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	32 feature you are adding.
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	33
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	34 - Make sure the test suites passes after your commit:
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	35 `bundle exec rspec spec/acceptance` More information on [testing](#Testing) below
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	36
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	37 - When introducing a new feature, make sure it is properly
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	38 documented in the README.md
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	39
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	40 * Submission:
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	41
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	42 * Pre-requisites:
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	43
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	44 - Make sure you have a [GitHub account](https://github.com/join)
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	45
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	46 - [Create a ticket](https://tickets.puppetlabs.com/secure/CreateIssue!default.jspa), or [watch the ticket](https://tickets.puppetlabs.com/browse/) you are patching for.
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	47
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	48 * Preferred method:
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	49
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	50 - Fork the repository on GitHub.
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	51
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	52 - Push your changes to a topic branch in your fork of the
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	53 repository. (the format ticket/1234-short_description_of_change is
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	54 usually preferred for this project).
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	55
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	56 - Submit a pull request to the repository in the puppetlabs
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	57 organization.
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	58
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	59 The long version
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	60 ================
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	61
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	62 1. Make separate commits for logically separate changes.
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	63
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	64 Please break your commits down into logically consistent units
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	65 which include new or changed tests relevant to the rest of the
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	66 change. The goal of doing this is to make the diff easier to
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	67 read for whoever is reviewing your code. In general, the easier
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	68 your diff is to read, the more likely someone will be happy to
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	69 review it and get it into the code base.
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	70
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	71 If you are going to refactor a piece of code, please do so as a
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	72 separate commit from your feature or bug fix changes.
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	73
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	74 We also really appreciate changes that include tests to make
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	75 sure the bug is not re-introduced, and that the feature is not
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	76 accidentally broken.
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	77
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	78 Describe the technical detail of the change(s). If your
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	79 description starts to get too long, that is a good sign that you
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	80 probably need to split up your commit into more finely grained
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	81 pieces.
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	82
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	83 Commits which plainly describe the things which help
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	84 reviewers check the patch and future developers understand the
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	85 code are much more likely to be merged in with a minimum of
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	86 bike-shedding or requested changes. Ideally, the commit message
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	87 would include information, and be in a form suitable for
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	88 inclusion in the release notes for the version of Puppet that
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	89 includes them.
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	90
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	91 Please also check that you are not introducing any trailing
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	92 whitespace or other "whitespace errors". You can do this by
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	93 running "git diff --check" on your changes before you commit.
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	94
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	95 2. Sending your patches
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	96
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	97 To submit your changes via a GitHub pull request, we _highly_
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	98 recommend that you have them on a topic branch, instead of
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	99 directly on "master".
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	100 It makes things much easier to keep track of, especially if
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	101 you decide to work on another thing before your first change
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	102 is merged in.
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	103
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	104 GitHub has some pretty good
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	105 [general documentation](http://help.github.com/) on using
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	106 their site. They also have documentation on
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	107 [creating pull requests](http://help.github.com/send-pull-requests/).
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	108
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	109 In general, after pushing your topic branch up to your
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	110 repository on GitHub, you can switch to the branch in the
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	111 GitHub UI and click "Pull Request" towards the top of the page
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	112 in order to open a pull request.
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	113
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	114
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	115 3. Update the related GitHub issue.
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	116
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	117 If there is a GitHub issue associated with the change you
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	118 submitted, then you should update the ticket to include the
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	119 location of your branch, along with any other commentary you
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	120 may wish to make.
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	121
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	122 Testing
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	123 =======
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	124
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	125 Getting Started
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	126 ---------------
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	127
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	128 Our puppet modules provide [`Gemfile`](./Gemfile)s which can tell a ruby
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	129 package manager such as [bundler](http://bundler.io/) what Ruby packages,
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	130 or Gems, are required to build, develop, and test this software.
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	131
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	132 Please make sure you have [bundler installed](http://bundler.io/#getting-started)
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	133 on your system, then use it to install all dependencies needed for this project,
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	134 by running
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	135
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	136 ```shell
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	137 % bundle install
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	138 Fetching gem metadata from https://rubygems.org/........
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	139 Fetching gem metadata from https://rubygems.org/..
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	140 Using rake (10.1.0)
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	141 Using builder (3.2.2)
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	142 -- 8><-- many more --><8 --
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	143 Using rspec-system-puppet (2.2.0)
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	144 Using serverspec (0.6.3)
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	145 Using rspec-system-serverspec (1.0.0)
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	146 Using bundler (1.3.5)
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	147 Your bundle is complete!
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	148 Use `bundle show [gemname]` to see where a bundled gem is installed.
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	149 ```
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	150
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	151 NOTE some systems may require you to run this command with sudo.
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	152
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	153 If you already have those gems installed, make sure they are up-to-date:
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	154
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	155 ```shell
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	156 % bundle update
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	157 ```
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	158
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	159 With all dependencies in place and up-to-date we can now run the tests:
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	160
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	161 ```shell
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	162 % rake spec
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	163 ```
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	164
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	165 This will execute all the [rspec tests](http://rspec-puppet.com/) tests
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	166 under [spec/defines](./spec/defines), [spec/classes](./spec/classes),
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	167 and so on. rspec tests may have the same kind of dependencies as the
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	168 module they are testing. While the module defines in its [Modulefile](./Modulefile),
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	169 rspec tests define them in [.fixtures.yml](./fixtures.yml).
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	170
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	171 Some puppet modules also come with [beaker](https://github.com/puppetlabs/beaker)
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	172 tests. These tests spin up a virtual machine under
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	173 [VirtualBox](https://www.virtualbox.org/)) with, controlling it with
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	174 [Vagrant](http://www.vagrantup.com/) to actually simulate scripted test
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	175 scenarios. In order to run these, you will need both of those tools
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	176 installed on your system.
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	177
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	178 You can run them by issuing the following command
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	179
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	180 ```shell
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	181 % rake spec_clean
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	182 % rspec spec/acceptance
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	183 ```
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	184
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	185 This will now download a pre-fabricated image configured in the [default node-set](./spec/acceptance/nodesets/default.yml),
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	186 install puppet, copy this module and install its dependencies per [spec/spec_helper_acceptance.rb](./spec/spec_helper_acceptance.rb)
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	187 and then run all the tests under [spec/acceptance](./spec/acceptance).
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	188
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	189 Writing Tests
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	190 -------------
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	191
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	192 XXX getting started writing tests.
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	193
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	194 If you have commit access to the repository
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	195 ===========================================
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	196
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	197 Even if you have commit access to the repository, you will still need to
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	198 go through the process above, and have someone else review and merge
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	199 in your changes. The rule is that all changes must be reviewed by a
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	200 developer on the project (that did not write the code) to ensure that
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	201 all changes go through a code review process.
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	202
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	203 Having someone other than the author of the topic branch recorded as
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	204 performing the merge is the record that they performed the code
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	205 review.
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	206
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	207
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	208 Additional Resources
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	209 ====================
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	210
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	211 * [Getting additional help](http://puppetlabs.com/community/get-help)
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	212
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	213 * [Writing tests](http://projects.puppetlabs.com/projects/puppet/wiki/Development_Writing_Tests)
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	214
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	215 * [Patchwork](https://patchwork.puppetlabs.com)
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	216
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	217 * [General GitHub documentation](http://help.github.com/)
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	218
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	219 * [GitHub pull request documentation](http://help.github.com/send-pull-requests/)
37675581a273 Update Puppet module for Apache (pulls in concat module) IBBoard <dev@ibboard.co.uk> parents: diff changeset	220

Mercurial > repos > other > Puppet

annotate modules/concat/CONTRIBUTING.md @ 36:37675581a273 puppet-3.6