-
Notifications
You must be signed in to change notification settings - Fork 287
Add contribution guidelines, including an AI use policy #985
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
+34
−1
Merged
Changes from all commits
Commits
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| See @CONTRIBUTING.md |
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 |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| AGENTS.md | ||
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 |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| # Contributing Guidelines | ||
|
|
||
| ## Submitting a pull request | ||
|
|
||
| If the pull request is not yet ready to be reviewed by the maintainers, ensure it is marked as "Draft". When it is ready, mark it as "Ready for Review". | ||
|
|
||
| Before marking a pull request as ready for review, ensure: | ||
|
|
||
| * Commits are cleanly separated and have useful (but concise) messages that explain WHAT changed and WHY. | ||
| * A changelog entry has been added to CHANGELOG.md under `## Unreleased`. Changelogs should be concise and focused on the end user. | ||
| * Code has been appropriately documented (doc comments, etc.) Documentation should be clear and thorough but not excessively verbose or repetitive. | ||
| * Code is appropriately formatted with `cargo fmt`. | ||
| * Test coverage is excellent and passes with `--all-features` enabled. | ||
| * Reference related issues with "closes #N" at the bottom of commit messages. | ||
| * If an issue or pull request has been created with assistance from AI tooling, the contributor MUST review their contributions before posting them. | ||
|
|
||
| ## AI-assisted contributions policy | ||
|
|
||
| The following policy is adapted from [Astral's AI contributions policy](https://github.com/astral-sh/.github/blob/main/AI_POLICY.md) | ||
|
|
||
| We allow using AI (e.g. LLMs) as tools for coding. However, you remain responsible for any code you publish, and we are responsible for any code we merge and release. | ||
|
|
||
| Contributing to this project means vouching for the quality, license compliance, and utility of your submission. | ||
|
|
||
| If you are opening an issue or pull request, we expect you to be able to explain the issue and/or proposed changes in your own words. This includes the issue / pull request body and responses to questions. **Do not copy responses from the AI when replying to questions from maintainers.** | ||
|
|
||
| Autonomous AI agents should not be used to reply to questions from maintainers. If you wish to include context from an interaction with AI in your comments, it must be in a quote block (e.g., using >) and disclosed as such. It must also be reviewed by the contributor for relevance and accuracy and accompanied by human commentary explaining the implications of the context. | ||
|
|
||
| Contributions which appear in violation of this policy may be be closed, perhaps without notice. |
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.
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.
Claude, for whatever reason is the only harness which doesn't support AGENTS.md. Annoying.
This is a symlink