Skip to content

contributing guide updates#881

Open
vadam5 wants to merge 7 commits intomainfrom
llane/contributing-udpates
Open

contributing guide updates#881
vadam5 wants to merge 7 commits intomainfrom
llane/contributing-udpates

Conversation

@vadam5
Copy link
Contributor

@vadam5 vadam5 commented Mar 11, 2026

Replacement PR for: #662
Contributors: @lbliii

first pass at guidelines for AI-enabled contributions. Open to all ideas/suggestions.


- **Understand your changes**: You must be able to explain and debug every line in your PR. Treat AI output as code from an untrusted source that requires your review.
- **Self-review and test**: Before requesting review, read through the diff carefully, run the test suite (`pytest`), and run pre-commit checks locally. Never treat AI-generated code as ready to merge without your own verification.
- **Keep PRs focused**: AI tools sometimes make "drive-by improvements" to unrelated code. Strip out any changes that are not directly relevant to the task at hand.
Copy link

Choose a reason for hiding this comment

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

What about document any needed drive-by enhancements as an issue?

Copy link

@jmabry jmabry left a comment

Choose a reason for hiding this comment

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

Documentation appears in triplicate. Possible to reference a single-source of truth so that is more DRY in any secondary docs?

```bash
git commit -s -S -m "Add reward function for code evaluation

Assisted-by: GitHub Copilot"
Copy link

Choose a reason for hiding this comment

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

why not instead add to PR template?

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