mirror of
https://github.com/crate-ci/typos.git
synced 2026-10-17 01:25:12 +02:00
docs(ai): Add an AI policy (#96)
I've considered policies ranging from: - Make it so I can't tell its AI (https://github.com/hawkw/mycelium/blob/main/CONTRIBUTING.md#ai-policy) - No AI creation with some carve outs (https://forge.rust-lang.org/policies/llm-usage.html) In creating this, I'm trying to think through negative cases like: - People jumping on clap's Discussions posting AI answers - Flooding repos with PRs - Insufficiently self-reviewed PRs - Clap completion PRs where I am trusting in the experience of the author - Bots - Karma farming On the flip side, I have found AI helpful for - Research on how something can be done - Writing an approximation of the code and then refactoring from there - Test generation - Rote tasks that aren't easy to automate Overall, I want to keep this simple avoiding digging into some of the specifics like Rust's policy like ensuring approved bots can be blocked by users.
This commit is contained in:
@@ -0,0 +1,16 @@
|
||||
<!-- Thanks for helping out! -->
|
||||
|
||||
### What does this PR try to solve?
|
||||
|
||||
<!-- a maintainer-approved Issue is required for non-trivial changes -->
|
||||
Closes #<!-- Issue # -->
|
||||
|
||||
### Notes to reviewers
|
||||
|
||||
<!--
|
||||
Examples:
|
||||
- Larger context this fits within
|
||||
- Manual testing and why it wasn't automated
|
||||
-->
|
||||
|
||||
LLM involvement: <!-- TODO -->
|
||||
@@ -0,0 +1,58 @@
|
||||
# AI policy
|
||||
|
||||
Project maintainers are responsible for any code that is published as part of a release.
|
||||
Contributors are responsible for their contributions, both in terms of communications and code.
|
||||
This responsibility is for both understanding of and the quality of their contributions.
|
||||
|
||||
## Personal use
|
||||
|
||||
You are free to use an AI locally for your own purposes,
|
||||
including to answer your questions, analyze, distill, refine, check, suggest, and review.
|
||||
|
||||
## Communication
|
||||
|
||||
**AI should not be used to generate comments when communicating with maintainers.**
|
||||
We expect comments on our projects to be written by humans.
|
||||
We may hide or delete any comments where we believe AI generation was involved.
|
||||
|
||||
If you are opening an issue,
|
||||
we expect you to have personally reproduced the problem and to describe it in your own words.
|
||||
|
||||
If you are opening a pull request,
|
||||
we expect you to be able to explain the proposed changes in your own words.
|
||||
This includes the pull request body and responses to questions.
|
||||
**Do not copy responses from an AI when replying to questions from maintainers.**
|
||||
Do not run agents or bots on pull requests without first getting approval.
|
||||
|
||||
We understand that AI is useful when communicating as a non-native English speaker.
|
||||
If you are using AI to edit your comments for this purpose,
|
||||
please take the time to ensure it reflects your own voice and ideas.
|
||||
If using AI for translation, we recommend writing in your native language and including the AI translation in a [`<details>` block].
|
||||
|
||||
If you wish to include context from an interaction with AI in your comments,
|
||||
it must be in a [`<details>` block] and disclosed as such.
|
||||
The block must include human commentary explaining the relevance and implications of the context.
|
||||
The content of your comment must stand on its own even without the quoted content.
|
||||
Do not share long snippets.
|
||||
|
||||
## Code
|
||||
|
||||
Using AI as tools for coding requires receiving permission on the relevant issue before a PR is posted.
|
||||
|
||||
This project requires a human in the loop who understands the work produced by AI.
|
||||
**We do not allow autonomous agents to be used for contributing to this project**.
|
||||
We will close any pull requests that we believe were created **without meaningful involvement** from the contributor.
|
||||
Contributions should not "read" as being written by an AI.
|
||||
|
||||
Some areas require specific expertise or care when touching.
|
||||
AI generated code, even with human review, is prohibited for:
|
||||
- none
|
||||
|
||||
We view AI as providing a way to improve quality and will hold AI-assisted contributions to a higher standard.
|
||||
We will be more free in asking for changes.
|
||||
|
||||
The involvement of AI assistance must be disclosed in PRs.
|
||||
|
||||
For documentation, including comments in code, see [Communication](#communication).
|
||||
|
||||
[`<details>` block]: https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/organizing-information-with-collapsed-sections)
|
||||
Reference in New Issue
Block a user