update changelog fragment guidance with examples #77040
Merged
Conversation
This file contains 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
ansibot
added
affects_2.13
core_review
nitzmahone
removed
the
needs_triage
acozine
reviewed
Feb 22, 2022
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
samccann
commented
Feb 22, 2022
webknjaz
reviewed
Feb 22, 2022
| .. code-block:: yaml | ||
|
|
||
| breaking_changes: | ||
| - ec2_instance - instance wait for state behavior has changed. If plays require the old behavior of waiting for the instance monitoring status to become OK when launching a new instance, the action will need to specify ``state: started`` (https://github.com/ansible-collections/amazon.aws/pull/481). |
There was a problem hiding this comment.
This snippet seems inconsistent with the paragraph above. The explanation says to use the present tense but the example has a mixture and starts with the past tense.
Should the guidance be made clearer? Does the "present tense" request imply an imperative mood?
There was a problem hiding this comment.
sorry about that, updated in #77138
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
SUMMARY
Community wanted better guidance on how to write good changelog fragments. This PR
Implements ansible-community/community-topics#64 where this was decided on.
There are two guides now - one for core and one for collections, thus the repeated content in this PR.
ISSUE TYPE
COMPONENT NAME
docs/docsite/rst/community/collection_development_process.rst
docs/docsite/rst/community/development_process.rst
ADDITIONAL INFORMATION