mirror of
https://github.com/slendidev/smath.git
synced 2026-08-06 02:39:38 +03:00
@@ -0,0 +1,11 @@
|
||||
# AGENTS.md
|
||||
|
||||
Instructions for agents working in this repo.
|
||||
|
||||
See the [`CONTRIBUTING.md`](CONTRIBUTING.md) file. Said file **must** be read, examined,
|
||||
and understood before any change is made by agents.
|
||||
|
||||
For agents that understand `@`-inclusion of other markdown files, said inclusion line for
|
||||
`CONTRIBUTING.md` follows, such that explicit reading of the file is not necessary:
|
||||
|
||||
@CONTRIBUTING.md
|
||||
@@ -0,0 +1,7 @@
|
||||
# CLAUDE.md
|
||||
|
||||
This project's agent guidance lives in [AGENTS.md](AGENTS.md), the single source of truth
|
||||
shared with other tools. Claude Code does not load `AGENTS.md` automatically, so it is
|
||||
imported here:
|
||||
|
||||
@AGENTS.md
|
||||
+34
-1
@@ -2,7 +2,9 @@
|
||||
|
||||
Welcome to `smath` contributors!
|
||||
|
||||
This document contains a set of guidelines to contribute to the project. If you feel like there's a mistake or something can be improved to this document, feel free to propose changes in a pull request.
|
||||
This document contains a set of guidelines to contribute to the project. If you
|
||||
feel like there's a mistake or something can be improved to this document, feel
|
||||
free to propose changes in a pull request.
|
||||
|
||||
## Philosophy
|
||||
|
||||
@@ -52,6 +54,37 @@ This project uses `clang-format` to maintain a consistent code style. Before ope
|
||||
git ls-files '*.hpp' '*.cpp' | xargs clang-format -i
|
||||
```
|
||||
|
||||
## AI-assisted contributions
|
||||
|
||||
AI-assisted contributions are allowed, subject to the following:
|
||||
|
||||
- A human must be in the loop at all times. AI tools may assist, but a human
|
||||
contributor must drive the work, review and understand every generated
|
||||
change, and take full responsibility for it. Do not submit code you have not
|
||||
read and understood.
|
||||
|
||||
- The assistance must be disclosed. Any commit produced with material AI help
|
||||
must carry an `Assisted-by:` trailer using a format similar to the Linux
|
||||
kernel's AI coding assistant format:
|
||||
|
||||
```
|
||||
Assisted-by: AGENT_NAME:MODEL_VERSION
|
||||
```
|
||||
|
||||
`AGENT_NAME` is the AI tool or framework (e.g. Codex, Claude, ...).
|
||||
`MODEL_VERSION` is the full model identifier, all lowercase, including any
|
||||
numeric, snapshot, or version suffix. Do not shorten it to the model family
|
||||
(e.g. use gpt-5-5, not gpt-5; use claude-opus-4-8, not claude-opus).
|
||||
|
||||
- Do not add `Co-authored-by:` trailers for the AI assistant. The
|
||||
`Assisted-by:` trailer already serves that purpose.
|
||||
|
||||
- The human contributor still signs off (see above). `Signed-off-by:` is the
|
||||
human's certification of, and responsibility for, the change.
|
||||
`Assisted-by:` only records which tool helped. It does not replace the sign-off or the human review.
|
||||
|
||||
Unreviewed, bulk, or fully-automated submissions are not accepted.
|
||||
|
||||
## Pull requests
|
||||
|
||||
- Keep changes focused and scoped to one topic.
|
||||
|
||||
Reference in New Issue
Block a user