Repository navigation
PYTHON-6219 Put team coding standards into the repo - #3171
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
🟡 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
Member
|
The new file is failing two lint checks |
Member
|
Can you also link the AGENTS.md file to this file? |
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-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