diff mbox series

AGENTS.md: tell the agent about conventions and standards

Message ID 20261029-agents-md-standard-v1-1-35d654788176@bootlin.com
State Under Review
Headers show
Series AGENTS.md: tell the agent about conventions and standards | expand

Commit Message

Antonin Godard Oct. 29, 2026, 12:36 p.m. UTC 
Instruct the agent to read our standards.md and conventions.rst
instructions.

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
 AGENTS.md | 5 +++++
 1 file changed, 5 insertions(+)


---
base-commit: 7b54854d12f3f2c909727702d39066a3d22a4a40
change-id: 20261029-agents-md-standard-8aa27007e35d
diff mbox series

Patch

diff --git a/AGENTS.md b/AGENTS.md
index 3f6ff1d7a..a6a040366 100644
--- a/AGENTS.md
+++ b/AGENTS.md
@@ -10,6 +10,11 @@  Guidance for AI agents working in the `yocto-docs` repository.
   PR conventions apply.
 - One Git commit per logical change (e.g., one commit per variable / family of
   variable documentation, or class documentation).
+- The standards described in `documentation/standards.md` should be followed as
+  much as possible when making changes.
+- The formatting conventions in `documentation/conventions.rst` should also be
+  followed when making changes. Those are user-facing conventions about how to
+  read and interpret the documentation.
 - Commit message format:
   - Summary line prefixed with either:
     - the rST file path *without* the "documentation/"