Skip to content

Commit b2ea39f

Browse files
Review PR checklist in CONTRIBUTING.md (#4291)
* Review PR checklist * Remove PR checklist items that are obsolete or duplicate other parts of the guidelines * Add headings to PR checklist * Move a PR checklist item to 'contributor's pledge' This is because this item should be on a contributor's mind permanently rather than something they have to remember before raising each PR.
1 parent fa1dc92 commit b2ea39f

File tree

1 file changed

+21
-18
lines changed

1 file changed

+21
-18
lines changed

CONTRIBUTING.md

Lines changed: 21 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ As a contributor, I will:
88

99
* Familiarize myself with the [Pull Request Checklist](#Pull-Request-Checklist) and [Foreman documentation minimalist style guide](#Foreman-documentation-minimalist-style-guide).
1010
* Open additional issues if my contribution is incomplete.
11+
* Put in my best effort to ensure that my contribution does not worsen the state of any build target.
12+
For example, this might include reviewing how my changes affect upstream build targets even when working on behalf of a downstream product.
1113

1214
## Maintainer's pledge
1315

@@ -20,28 +22,29 @@ As a maintainer, I will:
2022
Examples of trivial PRs: Fixing a typo, fixing markup, or fixing links.
2123
Non-trivial PRs might not only benefit from additional review but they also represent an opportunity for community members to ask questions and learn.
2224

23-
## Pull request checklist
25+
## Pull request checklists
26+
27+
Checklist for documentation contributions:
2428

25-
* [ ] Before pushing, I view my diff against master or the target branch and check for spelling mistakes, failed conflict resolutions, etc.
26-
* [ ] Before pinging others about my PR, I await the Github Actions to see if my branch builds.
27-
* [ ] If I add text that applies only to a specific downstream product, I notify others and give them a chance to request extending the `ifdef::[]` or `ifndef::[]` directive.
28-
* [ ] My change does not contain `Foreman`, `Satellite`, or `orcharhino`.
29-
Instead, I use attributes.
30-
* [ ] I don't add useless or trailing white space.
31-
* [ ] I put each sentence to its own line.
32-
* [ ] I write a meaningful commit message.
33-
See [seven rules for git commit messages](https://cbea.ms/git-commit/#seven-rules).
34-
* [ ] My change does not worsen the state of any build target.
3529
* [ ] My contribution is my own work and I agree to the license of the project.
3630
See [LICENSE](LICENSE).
37-
* [ ] If I make more than one change on my branch, I create more than one commit and rebase my branch to master.
38-
* [ ] My PR does not solely rely on internal resources to answer the _why_, but instead contains at least a basic description for the community.
39-
* [ ] When creating my PR, I select all branches I want my change to get cherry-picked to.
40-
* [ ] I am familiar to proper capitalization for project-specific terminology.
41-
See [Capitalization](#Capitalization).
42-
* [ ] The first line of the file contains the modular docs content type attribute, for example, `:_mod-docs-content-type: ASSEMBLY` for assemblies.
43-
* [ ] I fill out the cherry-picking list in the PR template to the best of my abilities to signify which versions my update applies to.
31+
* [ ] My commits include meaningful commit messages.
32+
See [seven rules for git commit messages](https://cbea.ms/git-commit/#seven-rules).
33+
* [ ] I write one sentence per line.
34+
See [One sentence per line](https://jeffkreeftmeijer.com/one-sentence-per-line/).
35+
* [ ] My change does not add trailing whitespaces.
36+
Some editors can help with this.
37+
For example, VS Code has multiple settings related to handling whitespaces.
38+
39+
Checklist for raising PRs:
40+
41+
* [ ] I re-read my work carefully before raising a PR or before marking a draft PR as ready for review.
42+
This can include using `git show`, viewing the diff against master or the target branch, running a local Vale check, and other methods.
43+
* [ ] My PR description includes a meaningful description of the changes for the community.
44+
* [ ] I fill out the cherry-picking list in the PR description to the best of my abilities to signify which versions my update applies to.
4445
If unsure, I let reviewers know so that they can assist.
46+
* [ ] Before pinging others about my PR, I await the GitHub Actions checks to see if my branch builds.
47+
If a GitHub check fails and I'm unsure how to proceed, I let reviewers know so that they can assist.
4548

4649
Each PR should undergo tech review.
4750
(Tech review is performed by an Engineer who did not author the PR. It can be skipped if the PR does not significantly change description of product behavior.)

0 commit comments

Comments
 (0)