Skip to content

docs(ai): disclose AI assistance #3229

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.

Sign up for GitHub

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

Closed
wants to merge 3 commits into from
Closed

docs(ai): disclose AI assistance #3229

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b30390d
docs(ai): disclose AI assistance
ashwinb Aug 22, 2025
7bcce1f
update
ashwinb Aug 22, 2025
0b3218e
Merge remote-tracking branch 'origin/main' into ai
ashwinb Aug 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,21 @@
We want to make contributing to this project as easy and transparent as
possible.

## AI Assistance Best Practices

AI-assisted coding has changed the nature of contributions. AI tools can now generate large volumes of (typically) low-quality code quickly, increasing the burden on reviewers and reducing opportunities for meaningful feedback. As a result, we urge contributors to disclose _how_ they used AI assistance and follow the best practices below.

Contributors could attest to:

- "I've reviewed and understood all code before submitting."
- "I've tested the changes and ensured they address only the issue at hand."
- "I've asked an AI system to review this code."
- "I've refined any AI-generated output to meet our standards."
- "I've looked at generated tests and ensured they are meaningful. e.g., they avoid using fragile mocks."

> [!IMPORTANT]
> We would like to move the emphasis from whether AI was used to _how_ it was used and what human oversight was applied.

Copy link
Contributor

Choose a reason for hiding this comment

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

Is there anything action item for author to add in PR Summary? Or we just ensure authors to follow this

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@slekkala1 yeah just hope they do!

Copy link
Collaborator

Choose a reason for hiding this comment

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

let's put the following in .github/PULL_REQUEST_TEMPLATE.md

## Developer Attestation

Please confirm the following:

- [ ] I've reviewed and understood all code before submitting.
- [ ] I've tested the changes and ensured they address only the issue at hand.
- [ ] I've asked an AI system to review this code.
- [ ] I've refined any AI-generated output to meet our standards.
- [ ] I've looked at generated tests and ensured they are meaningful (e.g., avoid using fragile mocks.

## Set up your development environment

We use [uv](https://github.com/astral-sh/uv) to manage python dependencies and virtual environments.
Expand Down
Loading