mirror of
https://github.com/crate-ci/typos.git
synced 2026-10-16 17:25:10 +02:00
docs(ai): Solidify the policy
This commit is contained in:
@@ -12,3 +12,5 @@ Examples:
|
||||
- Larger context this fits within
|
||||
- Manual testing and why it wasn't automated
|
||||
-->
|
||||
|
||||
LLM involvement: <!-- TODO -->
|
||||
|
||||
+45
-19
@@ -1,32 +1,58 @@
|
||||
# AI Policy
|
||||
# AI policy
|
||||
|
||||
We support using AI (i.e., 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.
|
||||
We hold a high bar for all contributions to our projects.
|
||||
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.
|
||||
|
||||
**AI should not be used to generate comments when communicating with maintainers**.
|
||||
## 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 any comments that we believe are AI generated.
|
||||
We may hide or delete any comments where we believe AI generation was involved.
|
||||
|
||||
If you are opening an issue,
|
||||
we expect you to describe the problem in your own words.
|
||||
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 the AI when replying to questions from maintainers.**
|
||||
|
||||
Due to the foundational nature of our projects,
|
||||
we require a human in the loop who understands the work produced by AI.
|
||||
**We do not allow autonomous agents to be used for contributing to our projects**.
|
||||
We will close any pull requests that we believe were created autonomously.
|
||||
|
||||
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 be accompanied by human commentary explaining the relevance and implications of the context.
|
||||
Do not share long snippets.
|
||||
**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 quote block.
|
||||
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