argotorg / argotorg/solidity

AI tool policy: add AGENTS.md

Open Beginner friendly
#16,996 1 comment 0 reactions 0 assignees View on GitHub
documentation :book:
Dominant language
C++
Stars
25.7k
Forks
6.2k
Avg merge
2d 19h
Merged PRs (30d)
29

Description

We have the AI policy in `contributing.rst` and the disclosure checkbox in the PR template, but no file that AI agents actually read.

Most coding agents pick up a root-level `AGENTS.md` automatically. So, the proposal is to add a minimal one that only points to existing docs (AI policy + disclosure, `CODING_STYLE.md`, `ReviewChecklist.md`, how to build and run the tests, Changelog expectations), plus a `CLAUDE.md` symlink. We would start with a minimal one, and we can improve it with coding style and stuff like that in future.

LLVM did the same recently:
- https://discourse.llvm.org/t/rfc-llvm-ai-tool-policy-agents-md/91712
- https://llvm.org/docs/AIToolPolicy.html (the "Handling violations" part could also go into contributing.rst)

Contributor guide

Open the contributing guide

Research direction

Start by reading contributing.rst, the PR template, CODING_STYLE.md, ReviewChecklist.md, and the documented build, test, and Changelog guidance. Add a minimal root-level AGENTS.md that points to those existing resources, plus the proposed CLAUDE.md symlink; done means both files are present without duplicating policy content.

Written by the indexing model from the issue text.

Assessment

Domain
developer-experience, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Active
Clarity
Clearly specified
Newbie friendliness
88/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.