Update CONTRIBUTING AI Policy - #1937
Open
xstoicunicornx wants to merge 2 commits into
Open
xstoicunicornx wants to merge 2 commits into
xstoicunicornx wants to merge 2 commits into
Conversation
xstoicunicornx
requested review from
DanGould,
benalleng,
spacebear21 and
zealsham
September 30, 2026 22:59
Collaborator
Coverage Report for CI Build 36910396434Coverage remained the same at 87.289%Details
Uncovered ChangesNo uncovered changes found. Coverage RegressionsNo coverage regressions found. Coverage Stats
💛 - Coveralls |
wslcb
approved these changes
Sep 30, 2026
spacebear21
reviewed
Oct 1, 2026
|
|
||
| Before opening a pull request, run an AI review of your branch locally and address any valid findings. For those who are unable to complete the local AI review, this must be disclosed in the pull request. Use the following prompt: | ||
|
|
||
| > Review the changes on this branch relative to `master`, commit by commit. Check for adherence to the guidelines in `.github/CONTRIBUTING.md`, relevant test coverage, consistency with the overall codebase, bugs, missed edge cases, unintended side effects, poor implementation choices, new panics or unwraps in library code, unintended public API changes, and other general concerns. |
Collaborator
There was a problem hiding this comment.
I'm not sure I like the idea of providing prompts in the human-level docs, perhaps this should live in AGENTS.md instead?
Collaborator
Author
There was a problem hiding this comment.
Agreed, updated.
xstoicunicornx
force-pushed
the
contrib-ai-policy
branch
from
October 1, 2026 16:57
d113329 to
1217bc5
Compare
Drop the requirement to disclose AI-generated code. Contributors remain responsible for understanding and explaining their changes, and pull requests must not be opened or driven by autonomous agents. Require disclosure of AI-generated communication, such as issue descriptions, pull request descriptions, and comments, and allow maintainers to moderate or block thoughtless AI-generated communication. Using AI only to fix grammar or translate text the contributor wrote does not need to be disclosed. Require a local AI review before opening a pull request, and disclosure when that review was not completed. Keep the review criteria in AGENTS.md, which coding agents load automatically, rather than as a prompt in the human-facing guide. Replace the AI disclosure checkbox in the pull request template with one for the local AI review. Move the section out from between the Commits and Nix Development Shells subsections, where the remaining Code subsections rendered as part of it, to a top-level section after Code.
Clippy and rustfmt enforce most style conventions, but not API design. Ask contributors to follow the idioms of the language they write in, since payjoin-ffi includes bindings in several languages, and point Rust contributors to the Rust API Guidelines for public APIs.
xstoicunicornx
force-pushed
the
contrib-ai-policy
branch
from
October 1, 2026 18:54
1217bc5 to
5dd32eb
Compare
Collaborator
Author
|
Agh sorry @caarloshenriq just pushed update! |
This branch has not been deployed
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
6 participants
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.
Given that AI code generation has quickly become ubiquitous, the existing AI Policy seemed a bit outdated and didn't feel useful or informative. I made updates to no longer focus on the code generation aspects of AI usage and instead focus on the aspects of AI usage that ensure that reviewer's time and attention is respected.
The main points are:
I also added a prompt that should be used to run the AI review and I would really like feedback on what others think of this prompt. I worry that it is a bit too verbose as is, but also think it is good to list specifics of what should be reviewed.
The second commit adds a section in
Codeguidelines about adhering to code conventions, since this is something and AI can enforce but a lint can't, but I'd like feedback on this as well.Assigning primary review to @DanGould but would like everyone's eyes on this.
Pull Request Checklist
Please confirm the following before requesting review:
AI
in the body of this PR.
reviewer
in the body of this PR.