-
Notifications
You must be signed in to change notification settings - Fork 1.1k
PYTHON-5401: Add AI Generated Contributions Policy #2696
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 1 commit
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
037bb09
PYTHON-5401: Add AI contributions policy
Jibola 92c82cb
Update CONTRIBUTING.md
Jibola 2a5ecd1
Merge branch 'master' into PYTHON-5401
Jibola 0f3dd56
changed language
Jibola b654837
Merge branch 'PYTHON-5401' of https://github.com/Jibola/mongo-python-…
Jibola 9981938
Potential fix for pull request finding
Jibola 98893a4
Merge branch 'master' into PYTHON-5401
Jibola 3a02f26
Update .github/pull_request_template.md
Jibola bd8f73d
Merge branch 'master' into PYTHON-5401
Jibola File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -85,49 +85,54 @@ likelihood for getting review sooner shoots up. | |||||
| - `versionadded:: 3.11` | ||||||
| - `versionchanged:: 3.5` | ||||||
|
|
||||||
| **Pull Request Template Breakdown** | ||||||
| ### AI-Generated Contributions Policy | ||||||
|
|
||||||
| - **Github PR Title** | ||||||
| #### Our Stance | ||||||
|
|
||||||
| - The PR Title format should always be | ||||||
| `[JIRA-ID] : Jira Title or Blurb Summary`. | ||||||
| **We do not accept pull requests that are primarily or substantially generated by AI tools** (ChatGPT, Copilot, etc.). All contributions must be written and understood by human contributors. | ||||||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. oo this change makes sense, is there a reason why you haven't made it yet? |
||||||
|
|
||||||
| - **JIRA LINK** | ||||||
| ##### Why This Policy Exists | ||||||
|
|
||||||
| - Convenient link to the associated JIRA ticket. | ||||||
| Many MongoDB libraries are foundational tools used in production systems worldwide. The nature of these libraries requires: | ||||||
|
|
||||||
| - **Summary** | ||||||
| - **Absolute correctness**: We have no margin for "generally right" code. Subtle bugs can cause data corruption, security vulnerabilities, or silent failures that only appear under specific conditions. | ||||||
|
|
||||||
| - Small blurb on why this is needed. The JIRA task should have | ||||||
| the more in-depth description, but this should still, at a | ||||||
| high level, give anyone looking an understanding of why the | ||||||
| PR has been checked in. | ||||||
| - **Deep domain expertise**: MongoDB's wire protocol, BSON specification, connection pooling, authentication mechanisms, and concurrency patterns require an understanding that AI cannot reliably provide. | ||||||
|
|
||||||
| - **Changes in this PR** | ||||||
| - **Long-term maintainability**: Contributors need to be able to explain *why* code is written a certain way, explain design decisions, and be available to iterate on their contributions. | ||||||
|
|
||||||
| - The explicit code changes that this PR is introducing. This | ||||||
| should be more specific than just the task name. (Unless the | ||||||
| task name is very clear). | ||||||
| - **Security responsibility**: Authentication, credential handling, and TLS implementation cannot be left to probabilistic code generation. | ||||||
|
|
||||||
| - **Test Plan** | ||||||
| ##### What This Means for Contributors | ||||||
|
|
||||||
| - Everything needs a test description. Describe what you did | ||||||
| to validate your changes actually worked; if you did | ||||||
| nothing, then document you did not test it. Aim to make | ||||||
| these steps reproducible by other engineers, specifically | ||||||
| with your primary reviewer in mind. | ||||||
| **Required:** | ||||||
|
|
||||||
| - **Screenshots** | ||||||
| - Full understanding of every line of code you submit | ||||||
| - Ability to explain and defend your implementation choices | ||||||
| - Willingness to iterate and maintain your contributions | ||||||
|
|
||||||
| - Any images that provide more context to the PR. Usually, | ||||||
| these just coincide with the test plan. | ||||||
| **Encouraged:** | ||||||
|
|
||||||
| - **Callouts or follow-up items** | ||||||
| - Using AI assistants as learning tools to understand concepts | ||||||
| - IDE autocomplete features that suggest standard patterns | ||||||
| - AI help for brainstorming approaches (but write the code yourself) | ||||||
|
|
||||||
| - This is a good place for identifying "to-dos" that you've | ||||||
| placed in the code (Must have an accompanying JIRA Ticket). | ||||||
| - Potential bugs that you are unsure how to test in the code. | ||||||
| - Opinions you want to receive about your code. | ||||||
| **Not allowed:** | ||||||
|
|
||||||
| - Submitting PRs generated solely by AI tools | ||||||
| - Copy-pasting AI-generated code without full understanding | ||||||
|
|
||||||
| ##### Disclosure | ||||||
|
|
||||||
| If you used AI assistance in any way during your contribution, please disclose what the AI assistant was used for in your PR description. When in doubt, mention it. | ||||||
|
|
||||||
| ##### Questions? | ||||||
|
|
||||||
| If you're unsure whether your contribution complies with this policy, please ask in an issue before submitting a PR. We're happy to guide contributors toward successful contributions. | ||||||
|
Jibola marked this conversation as resolved.
Outdated
Jibola marked this conversation as resolved.
Outdated
|
||||||
|
|
||||||
| --- | ||||||
|
|
||||||
| *This policy helps us maintain the reliability, security, and trustworthiness that production applications depend on. Thank you for understanding and for contributing thoughtfully to PyMongo.* | ||||||
|
|
||||||
| ## Running Linters | ||||||
|
|
||||||
|
|
||||||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
wait i think this line should be updated too?