Skip to content

Commit

Permalink
(docs) Remove trivial patch section
Browse files Browse the repository at this point in the history
  • Loading branch information
joshcooper committed Oct 25, 2023
1 parent 63902ae commit e7cb24a
Showing 1 changed file with 0 additions and 23 deletions.
23 changes: 0 additions & 23 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,29 +84,6 @@ When adding user-facing strings to your work, follow these guidelines:
It is the responsibility of contributors and code reviewers to ensure that all
user-facing strings are marked in new PRs before merging.

## Making Trivial Changes

For [changes of a trivial nature](https://puppet.com/community/trivial-patch-exemption-policy), it is not always necessary to create a new
ticket in Jira. In this case, it is appropriate to start the first line of a
commit with one of `(docs)`, `(maint)`, or `(packaging)` instead of a ticket
number.

If a Jira ticket exists for the documentation commit, you can include it
after the `(docs)` token.

```
(docs)(DOCUMENT-000) Add docs commit example to CONTRIBUTING
There is no example for contributing a documentation commit
to the Puppet 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 '(docs)' in
place of what would have been the PUP project ticket number in a
non-documentation related commit. The body describes the nature of
the new documentation or comments added.
```

For commits that address trivial repository maintenance tasks or packaging
issues, start the first line of the commit with `(maint)` or `(packaging)`,
respectively.
Expand Down

0 comments on commit e7cb24a

Please sign in to comment.