Repository navigation
PYTHON-6088 Document changelog style guide - #3178
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Warning
Copilot couldn't run its full agentic review because it didn't start before the timeout. Make sure your repository has a runner available, or add a copilot-code-review.yml file specifying one with the runs-on attribute. See the docs for more details.
Copilot review overview
2 open issues
What changed in this PR
Expands the changelog section in CODING-STANDARDS.md to define a clearer, more prescriptive changelog formatting and style guide.
Changes:
- Requires changelog entries to be past tense, proper grammar, and user-focused.
- Standardizes changelog entry categorization keywords (Added/Changed/Deprecated/Removed/Fixed/Security) and grouping.
- Defines how to reference code via Sphinx roles and when to use inline code formatting.
| File | Description |
|---|---|
| CODING-STANDARDS.md | Expands the changelog guidance with explicit formatting, categorization, and cross-reference rules. |
Review effort: Lite
| 4. Group all entries of the same type together in each version. | ||
| 5. Changelog entries do not contain implementation details. | ||
| 6. Use the guiding principle of "what would a user want to know about this" when describing a change. | ||
| 7. Changelog entries must end with a link to the JIRA ticket that implemented their changes. |
| 4. `Removed`: features removed in the described version. | ||
| 5. `Fixed`: bug fixes. | ||
| 6. `Security`: patched vulnerabilities. | ||
| 4. Group all entries of the same type together in each version. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.


PYTHON-6088
Changes in this PR
Expand the changelog section in
CODING-STANDARDS.mdto explicitly define changelog formatting and style.Test Plan
N/A.
Checklist
Checklist for Author
[ ] Did you update the changelog (if necessary)?[ ] Is there test coverage?[ ] Is any followup work tracked in a JIRA ticket? If so, add link(s).Checklist for Reviewer