Skip to content

Commit

Permalink
(PA-538) refer to Puppet agent not Puppet Agent in docs
Browse files Browse the repository at this point in the history
This commit updates CONTRIBUTING and COMMITTERS to reference Puppet agent
instead of Puppet Agent, as requested by our Tech Pubs team.
  • Loading branch information
Moses Mendoza committed Sep 21, 2016
1 parent 9e0fe84 commit ae22474
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 12 deletions.
16 changes: 8 additions & 8 deletions COMMITTERS.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Committing changes to Puppet Agent
Committing changes to Puppet agent
====

This document is liberally copied/based on the same in
Expand Down Expand Up @@ -38,12 +38,12 @@ Terminology
Many of these terms have more than one meaning. For the purposes of this
document, the following terms refer to specific things.

**contributor** - A person who makes a change to Puppet Agent and submits a
**contributor** - A person who makes a change to Puppet agent and submits a
change set in the form of a pull request.

**change set** - A set of discrete patches which combined together form a
contribution. A change set takes the form of Git commits and is submitted to
Puppet Agent in the form of a pull request.
Puppet agent in the form of a pull request.

**committer** - A person responsible for reviewing a pull request and then
making the decision what base branch to merge the change set into.
Expand Down Expand Up @@ -143,12 +143,12 @@ This section aims to provide guidelines for being a good commit citizen by
paying attention to our automated build tools.

* Don’t push on a broken build. (A broken build is defined as a failing job
in the [Puppet Agent](https://jenkins.puppetlabs.com/view/puppet-agent/)
in the [Puppet agent](https://jenkins.puppetlabs.com/view/puppet-agent/)
page.)
* Watch the build until your changes have gone through green.
* Update the ticket status and target version. The target version field in
our issue tracker should be updated to be the next release of Puppet Agent.
For example, if the most recent release of Puppet Agent is 1.6.2 and you
our issue tracker should be updated to be the next release of Puppet agent.
For example, if the most recent release of Puppet agent is 1.6.2 and you
merge a backwards compatible change set into master, then the target version
should be 1.7.0 in the issue tracker.)
* Ensure the pull request is closed (Hint: amend your merge commit to contain
Expand All @@ -163,8 +163,8 @@ branch, then merge into the base branch and up through all active base
branches.

Suppose a contributor submits a pull request based on master. The change set
fixes a bug reported against Puppet Agent 1.6.2 which is the most recently
released version of Puppet Agent.
fixes a bug reported against Puppet agent 1.6.2 which is the most recently
released version of Puppet agent.

In this example the committer should rebase the change set onto the `stable`
branch since this is a bug rather than new functionality.
Expand Down
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ This document is liberally copied/based on the same in
[Puppet](https://github.com/puppetlabs/puppet).

Third-party patches, as well as patches from those within Puppet who don't
maintain this project directly, are essential for keeping Puppet Agent
maintain this project directly, are essential for keeping Puppet agent
great. We simply can't access the huge number of platforms and myriad
configurations for running Puppet Agent. We want to keep it as easy as possible
configurations for running Puppet agent. We want to keep it as easy as possible
to contribute changes that get things working in your environment. There are a
few guidelines that we need contributors to follow so that we can have a chance
of keeping on top of things.
Expand Down Expand Up @@ -48,7 +48,7 @@ of keeping on top of things.
why this is a problem, and how the patch fixes the problem when applied.
````

* Puppet Agent does not currently have automated tests, as it is tested
* Puppet agent does not currently have automated tests, as it is tested
indirectly via its components. In the future additional automated validation
may be added.

Expand All @@ -65,7 +65,7 @@ a ticket number.
(doc) Add documentation commit example to CONTRIBUTING
There is no example for contributing a documentation commit
to the Puppet Agent repository. This is a problem because the contributor
to the Puppet agent repository. This is a problem because the contributor
is left to assume how a commit of this nature may appear.
The first line is a real life imperative statement with '(doc)' in
Expand Down

0 comments on commit ae22474

Please sign in to comment.