Added AI Policy to README (#489)

Addresses #479, and adds a section for an AI policy based on what is
outlined by @niklasmohrin in that issue. The AI Policy is located below
the "Development" section.
This commit is contained in:
RedHare 2026-07-04 17:05:15 -04:00 committed by GitHub
commit df5113ddaa
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -86,6 +86,17 @@ To run lints:
$ cargo clean && cargo clippy $ cargo clean && cargo clippy
### AI Policy
Using AI is generally discouraged. However, if it is used as part of a contribution, the contributor MUST:
1. Clearly mark what parts (if any) of a contribution were created with the help of AI tools. This includes issue and pull request comments.
2. Check all output of AI tools before sharing it with others in the tealdeer project.
3. Not post slop, spam, or low quality contributions. This includes pull request descriptions and comments with excessive text and markdown flair.
4. Leave small or easy tasks to new contributors who want to learn without the use of AI. This is to maintain the presence of the `good-first-issue` tag.
5. Be respectful of everyone's time: *maintainers and other contributors will be reviewing your PRs.*
## MSRV (Minimally Supported Rust Version) ## MSRV (Minimally Supported Rust Version)
When publishing a tealdeer release, the Rust version required to build it When publishing a tealdeer release, the Rust version required to build it