Add an AGENTS.md authoring guide

Open Beginner friendly
#20 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
66/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Tech stack
csharp, markdown, node.js, python, scala
Domain
documentation

Research direction

Inspect the repo for existing guidance docs, especially any copilot-instructions.md, CLAUDE.md, and any AGENTS.md references, to align tone and placement. Add the new AGENTS.md with the requested sections: purpose, what to include/exclude, precedence among instruction files, and a starter template. Include clear mentions/examples for Python, Node.js, Scala, and .NET in the nested-language guidance. There are no tests to run; completion is a documented, copy-ready guide that addresses every bullet in the request.

Written by the indexing model from the issue text.

Description

documentation

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).
Dominant language
Python
Stars
1
Forks
0
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from AbsaOSS/agentic-toolkit

All issues in AbsaOSS/agentic-toolkit

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.