AbsaOSS / AbsaOSS/agentic-toolkit

Add an AGENTS.md authoring guide

Abierto
#20 0 comentarios 0 reacciones 0 asignados Ver en GitHub
documentation
Lenguaje dominante
Python
Estrellas
1
Forks
0
Merge medio
16 h 52 min
PR fusionados (30 d)
1

Descripción

## Summary

Add a guide on authoring **`AGENTS.md`** — the cross-tool standard for giving AI coding agents project-specific instructions. Our colleagues run several agents (GitHub Copilot CLI, OpenCode, Pi), and a single `AGENTS.md` is read natively by all of them, so conventions are written once instead of re-explained every session (saving input tokens and forming a stable, cacheable context prefix).

## The guide should cover

- What `AGENTS.md` is and why it matters for a multi-tool, budget-conscious team.
- What to put in it (and what not to).
- **Nested per-language `AGENTS.md`** for our stack — Python, Node, Scala, .NET — since conventions differ per language.
- How it relates to tool-specific files (e.g. `copilot-instructions.md`, `CLAUDE.md`) and which to prefer.
- A short starter template.

## Notes

- Back the findings with web research across multiple independent sources.
- Keep it tool-general (team primarily uses GitHub Copilot CLI, plus OpenCode and Pi).

Guía de contribución

Abrir la guía de contribución

Evaluación

Este issue todavía no se ha evaluado.

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.