Skip to content

PYTHON-6088 Document changelog style guide - #3178

Merged
NoahStapp merged 1 commit into
mongodb:mainfrom
NoahStapp:PYTHON-6088
Nov 6, 2026
Merged

NoahStapp merged 1 commit into
mongodb:mainfrom
NoahStapp:PYTHON-6088

Conversation

@NoahStapp

Copy link
Copy Markdown
Contributor

PYTHON-6088

Changes in this PR

Expand the changelog section in CODING-STANDARDS.md to 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

  • Does the title of the PR reference a JIRA Ticket?
  • Do you fully understand the implementation? (Would you be comfortable explaining how this code works to someone else?)
  • Is all relevant documentation (README or docstring) updated?

@NoahStapp
NoahStapp requested a review from a team as a code owner November 5, 2026 16:00
@NoahStapp
NoahStapp requested review from blink1073 and a balanced review from Copilot November 5, 2026 16:00

@blink1073 blink1073 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Comment thread CODING-STANDARDS.md
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.
Comment thread CODING-STANDARDS.md
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.
@NoahStapp
NoahStapp merged commit e70dfcb into mongodb:main Nov 6, 2026
82 of 83 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants