Enhance "Making your PR Merge Worthy" section #3028
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Fix the number-verb agreement in a bullet point - Add a link to the RST spec and re-word the embedding
I find the title "Creating changelog fragments" too similar to "Creating a changelog fragment".
pkingstonxyz
temporarily deployed
to
github-bot
GitHub Actions
Inactive
ansible-documentation-bot
bot
added
the
new_contributor
Contributor
|
Thanks for your Ansible docs contribution! We talk about Ansible documentation on Matrix at #docs:ansible.im if you ever want to join us and chat about the docs! We meet on Matrix every Tuesday. See the Ansible calendar for meeting details. We welcome additions to our weekly agenda items too. You can add the |
pkingstonxyz
commented
Sep 5, 2025
pkingstonxyz
temporarily deployed
to
github-bot
GitHub Actions
Inactive
pkingstonxyz
temporarily deployed
to
github-bot
GitHub Actions
Inactive
Capitalizing these helps to distinguish between the yaml/rst format and file extension.
pkingstonxyz
temporarily deployed
to
github-bot
GitHub Actions
Inactive
Contributor
Author
|
3a2fcd4 only capitalizes some acronyms I have no idea why this is failing. |
Contributor
@pkingstonxyz Likely one of those transitive blips that just happen from time to time. The check was fine when I re-ran it so whatever the cause, it was unrelated to your commit. |
webknjaz
reviewed
Sep 8, 2025
Co-authored-by: 🇺🇦 Sviatoslav Sydorenko (Святослав Сидоренко) <[email protected]>
pkingstonxyz
temporarily deployed
to
github-bot
GitHub Actions
Inactive
pkingstonxyz
temporarily deployed
to
github-bot
GitHub Actions
Inactive
Co-authored-by: 🇺🇦 Sviatoslav Sydorenko (Святослав Сидоренко) <[email protected]>
pkingstonxyz
temporarily deployed
to
github-bot
GitHub Actions
Inactive
oraNod
approved these changes
Nov 10, 2025
Contributor
oraNod
left a comment
oraNod
left a comment
There was a problem hiding this comment.
LGTM. Thanks very much for the contribution @pkingstonxyz
oraNod
added
backport-2.17
oraNod
added
the
backport-2.20
Backport to stable-2.17: 💚 backport PR created✅ Backport PR branch: Backported as #3242 🤖 @patchback |
patchback bot
pushed a commit
that referenced
this pull request
Nov 10, 2025
* Fix grammar and add documentation link - Fix the number-verb agreement in a bullet point - Add a link to the RST spec and re-word the embedding * Add small section on testing * Edit title for Changelog section I find the title "Creating changelog fragments" too similar to "Creating a changelog fragment". * Update title of test section and reorganize sentences * Fix spelling of preferred * Add words for clarity * Capitalize YAML and RST Capitalizing these helps to distinguish between the yaml/rst format and file extension. * Fix line breaks in test section Co-authored-by: 🇺🇦 Sviatoslav Sydorenko (Святослав Сидоренко) <[email protected]> * Rephrase testing section * Fix period clickability Co-authored-by: 🇺🇦 Sviatoslav Sydorenko (Святослав Сидоренко) <[email protected]> --------- Co-authored-by: 🇺🇦 Sviatoslav Sydorenko (Святослав Сидоренко) <[email protected]> (cherry picked from commit b2a6c41)
Backport to stable-2.18: 💚 backport PR created✅ Backport PR branch: Backported as #3243 🤖 @patchback |
patchback bot
pushed a commit
that referenced
this pull request
Nov 10, 2025
* Fix grammar and add documentation link - Fix the number-verb agreement in a bullet point - Add a link to the RST spec and re-word the embedding * Add small section on testing * Edit title for Changelog section I find the title "Creating changelog fragments" too similar to "Creating a changelog fragment". * Update title of test section and reorganize sentences * Fix spelling of preferred * Add words for clarity * Capitalize YAML and RST Capitalizing these helps to distinguish between the yaml/rst format and file extension. * Fix line breaks in test section Co-authored-by: 🇺🇦 Sviatoslav Sydorenko (Святослав Сидоренко) <[email protected]> * Rephrase testing section * Fix period clickability Co-authored-by: 🇺🇦 Sviatoslav Sydorenko (Святослав Сидоренко) <[email protected]> --------- Co-authored-by: 🇺🇦 Sviatoslav Sydorenko (Святослав Сидоренко) <[email protected]> (cherry picked from commit b2a6c41)
Backport to stable-2.19: 💚 backport PR created✅ Backport PR branch: Backported as #3244 🤖 @patchback |
patchback bot
pushed a commit
that referenced
this pull request
Nov 10, 2025
* Fix grammar and add documentation link - Fix the number-verb agreement in a bullet point - Add a link to the RST spec and re-word the embedding * Add small section on testing * Edit title for Changelog section I find the title "Creating changelog fragments" too similar to "Creating a changelog fragment". * Update title of test section and reorganize sentences * Fix spelling of preferred * Add words for clarity * Capitalize YAML and RST Capitalizing these helps to distinguish between the yaml/rst format and file extension. * Fix line breaks in test section Co-authored-by: 🇺🇦 Sviatoslav Sydorenko (Святослав Сидоренко) <[email protected]> * Rephrase testing section * Fix period clickability Co-authored-by: 🇺🇦 Sviatoslav Sydorenko (Святослав Сидоренко) <[email protected]> --------- Co-authored-by: 🇺🇦 Sviatoslav Sydorenko (Святослав Сидоренко) <[email protected]> (cherry picked from commit b2a6c41)
Backport to stable-2.20: 💚 backport PR created✅ Backport PR branch: Backported as #3245 🤖 @patchback |
patchback bot
pushed a commit
that referenced
this pull request
Nov 10, 2025
* Fix grammar and add documentation link - Fix the number-verb agreement in a bullet point - Add a link to the RST spec and re-word the embedding * Add small section on testing * Edit title for Changelog section I find the title "Creating changelog fragments" too similar to "Creating a changelog fragment". * Update title of test section and reorganize sentences * Fix spelling of preferred * Add words for clarity * Capitalize YAML and RST Capitalizing these helps to distinguish between the yaml/rst format and file extension. * Fix line breaks in test section Co-authored-by: 🇺🇦 Sviatoslav Sydorenko (Святослав Сидоренко) <[email protected]> * Rephrase testing section * Fix period clickability Co-authored-by: 🇺🇦 Sviatoslav Sydorenko (Святослав Сидоренко) <[email protected]> --------- Co-authored-by: 🇺🇦 Sviatoslav Sydorenko (Святослав Сидоренко) <[email protected]> (cherry picked from commit b2a6c41)
oraNod
pushed a commit
that referenced
this pull request
Nov 10, 2025
* Fix grammar and add documentation link - Fix the number-verb agreement in a bullet point - Add a link to the RST spec and re-word the embedding * Add small section on testing * Edit title for Changelog section I find the title "Creating changelog fragments" too similar to "Creating a changelog fragment". * Update title of test section and reorganize sentences * Fix spelling of preferred * Add words for clarity * Capitalize YAML and RST Capitalizing these helps to distinguish between the yaml/rst format and file extension. * Fix line breaks in test section * Rephrase testing section * Fix period clickability --------- (cherry picked from commit b2a6c41) Co-authored-by: Patrick Kingston <[email protected]> Co-authored-by: 🇺🇦 Sviatoslav Sydorenko (Святослав Сидоренко) <[email protected]>
oraNod
pushed a commit
that referenced
this pull request
Nov 10, 2025
* Fix grammar and add documentation link - Fix the number-verb agreement in a bullet point - Add a link to the RST spec and re-word the embedding * Add small section on testing * Edit title for Changelog section I find the title "Creating changelog fragments" too similar to "Creating a changelog fragment". * Update title of test section and reorganize sentences * Fix spelling of preferred * Add words for clarity * Capitalize YAML and RST Capitalizing these helps to distinguish between the yaml/rst format and file extension. * Fix line breaks in test section * Rephrase testing section * Fix period clickability --------- (cherry picked from commit b2a6c41) Co-authored-by: Patrick Kingston <[email protected]> Co-authored-by: 🇺🇦 Sviatoslav Sydorenko (Святослав Сидоренко) <[email protected]>
oraNod
pushed a commit
that referenced
this pull request
Nov 10, 2025
* Fix grammar and add documentation link - Fix the number-verb agreement in a bullet point - Add a link to the RST spec and re-word the embedding * Add small section on testing * Edit title for Changelog section I find the title "Creating changelog fragments" too similar to "Creating a changelog fragment". * Update title of test section and reorganize sentences * Fix spelling of preferred * Add words for clarity * Capitalize YAML and RST Capitalizing these helps to distinguish between the yaml/rst format and file extension. * Fix line breaks in test section * Rephrase testing section * Fix period clickability --------- (cherry picked from commit b2a6c41) Co-authored-by: Patrick Kingston <[email protected]> Co-authored-by: 🇺🇦 Sviatoslav Sydorenko (Святослав Сидоренко) <[email protected]>
oraNod
pushed a commit
that referenced
this pull request
Nov 10, 2025
* Fix grammar and add documentation link - Fix the number-verb agreement in a bullet point - Add a link to the RST spec and re-word the embedding * Add small section on testing * Edit title for Changelog section I find the title "Creating changelog fragments" too similar to "Creating a changelog fragment". * Update title of test section and reorganize sentences * Fix spelling of preferred * Add words for clarity * Capitalize YAML and RST Capitalizing these helps to distinguish between the yaml/rst format and file extension. * Fix line breaks in test section * Rephrase testing section * Fix period clickability --------- (cherry picked from commit b2a6c41) Co-authored-by: Patrick Kingston <[email protected]> Co-authored-by: 🇺🇦 Sviatoslav Sydorenko (Святослав Сидоренко) <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR seeks to increase the clarity and scope of the "Making your PR Merge Worthy"
section of the The Ansible Development Cycle page.
It updates the wording of the changelog section to fix some small grammar issues and
includes a link to the RST specification.
This PR also adds a section "Testing PRs" with links to information on Integration and
Unit tests because one of the most common comments on PRs is some variation of "Can you write some tests for this?"