Skip to content

PYTHON-6219 Put team coding standards into the repo - #3171

Merged
NoahStapp merged 3 commits into
mongodb:mainfrom
NoahStapp:PYTHON-6219
Nov 2, 2026
Merged

NoahStapp merged 3 commits into
mongodb:mainfrom
NoahStapp:PYTHON-6219

Conversation

@NoahStapp

Copy link
Copy Markdown
Contributor

PYTHON-6219

Changes in this PR

Put the team coding standards document into the repo.

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 2, 2026 16:58
@NoahStapp
NoahStapp requested review from blink1073 and a balanced review from Copilot November 2, 2026 16:58

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.

🟡 Changes recommended

CODING-STANDARDS.md contains an ambiguous argument-naming rule and an example missing the TYPE_CHECKING import, which would raise NameError if copied into a module.

2 open issues
What changed in this PR

Adds a repository-local coding standards document for projects maintained by the Python Drivers team, providing shared guidance for writing and reviewing code.

Changes:

  • Defines expectations for comments, Sphinx docstrings, code style, design, error handling, and performance.
  • Documents testing, typing, backward compatibility, changelog, and Git practices.
File Description
CODING-STANDARDS.md Adds team-wide coding and contribution standards; no runtime code changes.

Review effort: Balanced

Comment thread CODING-STANDARDS.md Resolved
Comment thread CODING-STANDARDS.md Resolved
@blink1073

Copy link
Copy Markdown
Member

The new file is failing two lint checks

@blink1073

Copy link
Copy Markdown
Member

Can you also link the AGENTS.md file to this file?

@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!

@NoahStapp
NoahStapp merged commit 06316c3 into mongodb:main Nov 2, 2026
37 of 38 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