doc(ai): add AI documentation and usage guidelines with AGENTS file

This commit is contained in:
Aaron U'Ren 2026-03-08 21:32:36 -05:00 committed by Aaron U'Ren
parent f05ae5a1a3
commit ac57ed5fb0
3 changed files with 1528 additions and 0 deletions

5
.gitignore vendored
View File

@ -44,3 +44,8 @@ go.work.sum
# env file
.env
# AI stuff
/.plans
/.reviews
/.opencode

1459
AGENTS.md Normal file

File diff suppressed because it is too large Load Diff

64
AI_POLICY.md Normal file
View File

@ -0,0 +1,64 @@
<!-- Adapted from https://github.com/ghostty-org/ghostty/blob/main/AI_POLICY.md -->
<!-- MIT License, Copyright (c) Ghostty contributors -->
# AI Usage Policy
The kube-router project has strict rules for AI usage:
- **All AI usage in any form must be disclosed.** You must state
the tool you used (e.g. Claude Code, Cursor, Amp) along with
the extent that the work was AI-assisted.
- **The human-in-the-loop must fully understand all code.** If you
can't explain what your changes do and how they interact with the
greater system without the aid of AI tools, do not contribute
to this project.
- **Issues and discussions can use AI assistance but must have a full
human-in-the-loop.** This means that any content generated with AI
must have been reviewed _and edited_ by a human before submission.
AI is very good at being overly verbose and including noise that
distracts from the main point. Humans must do their research and
trim this down.
- **No AI-generated media is allowed (art, images, videos, audio, etc.).**
Text and code are the only acceptable AI-generated content, per the
other rules in this policy.
- **Bad AI drivers will be blocked.** People who continuously produce
bad contributions that are clearly AI (slop) will be blocked from
future interactions via the GitHub project interface.
These rules apply only to outside contributions to kube-router. Maintainers
are exempt from these rules and may use AI tools at their discretion;
they've proven themselves trustworthy to apply good judgment.
## There are Humans Here
Please remember that kube-router is maintained by humans.
Every discussion, issue, and pull request is read and reviewed by
humans (and sometimes machines, too). It is a boundary point at which
people interact with each other and the work done. It is rude and
disrespectful to approach this boundary with low-effort, unqualified
work, since it puts the burden of validation on the maintainer.
In a perfect world, AI would produce high-quality, accurate work
every time. But today, that reality depends on the driver of the AI.
And today, most drivers of AI are just not good enough. So, until either
the people get better, the AI gets better, or both, we have to have
strict rules to protect maintainers.
## AI is Welcome Here
kube-router is written with plenty of AI assistance, and many maintainers
embrace AI tools as a productive tool in their workflow. As a project, we
welcome AI as a tool!
**Our reason for the strict AI policy is not due to an anti-AI stance**, but
instead due to the number of highly unqualified people using AI. It's the
people, not the tools, that are the problem.
We include this section to be transparent about the project's usage of
AI for people who may disagree with it, and to address the misconception
that this policy is anti-AI in nature.