Skip to content

Add repository-level AGENTS.md with executable guidance and agent guardrails#10

Merged
sayuru-akash merged 3 commits intomainfrom
copilot/initiate-agents-md-file
Mar 17, 2026
Merged

Add repository-level AGENTS.md with executable guidance and agent guardrails#10
sayuru-akash merged 3 commits intomainfrom
copilot/initiate-agents-md-file

Conversation

Copy link
Copy Markdown

Copilot AI commented Mar 17, 2026

This PR adds a root AGENTS.md to give coding agents a single, structured operating guide for this
repository. It follows the required section order and uses only repo-verified details, with explicit
> TODO: markers where project policy or tooling is not currently documented.

  • Scope

    • Added /AGENTS.md as the canonical agent instruction file for this repo.
  • Structured operating guide (required section order)

    • # Project Overview
    • ## Repository Structure
    • ## Build & Development Commands
    • ## Code Style & Conventions
    • ## Architecture Notes
    • ## Testing Strategy
    • ## Security & Compliance
    • ## Agent Guardrails
    • ## Extensibility Hooks
    • ## Further Reading
  • Command and workflow coverage

    • Captures install/run/test/lint/build/debug/deploy commands from existing repo docs/scripts.
    • Preserves existing commands verbatim where already defined by the project (e.g. composer run dev,
      composer run setup, php artisan test, npm run build).
  • Unknowns handled explicitly

    • Inserts > TODO: markers for missing documented policy (commit message format, CI test workflow
      documentation, explicit automation rate limits, formal feature-flag process, static type-check command).
  • Architecture + governance content

    • Adds a high-level Mermaid dataflow diagram (routes → controllers/services/models → DB/views/queue).
    • Defines agent boundaries for sensitive areas (.env secrets, server_utils/, high-impact config/schema edits).

Example excerpt:

## Build & Development Commands
```bash
composer run setup
composer run dev
php artisan test
./vendor/bin/pint
npm run build

Agent Guardrails

  1. Do not edit or commit secrets (.env, credential dumps, private keys).
  2. Do not modify server_utils/ utilities without explicit human approval.

<!-- START COPILOT ORIGINAL PROMPT -->



<details>

<summary>Original prompt</summary>

> 
> ----
> 
> *This section details on the original issue you should resolve*
> 
> <issue_title>Initiate a correct agents.md and PR it</issue_title>
> <issue_description>### ABOUT
> Modern AI coding tools converge on a simple idea: give the agent a **single, well-structured Markdown file that explains how your repo “works,”** and prepend that file to every LLM call so the agent never has to guess about architecture, commands, or conventions. Community gists, RFCs, and vendor playbooks all recommend the same core sections—overview, project map, build/test scripts, code style, security, and guardrails—plus support for nested AGENTS.md files that override one another hierarchically.
> 
> ### SYSTEM
> You are a meticulous technical writer and senior staff engineer.  
> Your task is to create **AGENTS.md** for the repository whose contents are provided below.
> 
> ### CONTEXT (replace the JSON blocks)
> See the attached files.
> 
> ### REQUIRED SECTIONS
> 
> Produce Markdown exactly in this order:
> 
> 1. `# Project Overview` – one-paragraph description and elevator pitch.
> 2. `## Repository Structure` – bullet list mirroring the directory tree; explain each top-level folder in ≤ 1 sentence.
> 3. `## Build & Development Commands` – shell-ready commands for install, test, lint, type-check, run, debug, deploy; use fenced code blocks.
> 4. `## Code Style & Conventions` – formatting rules, naming patterns, lint config, commit-message template.
> 5. `## Architecture Notes` – high-level diagram in Mermaid **or** ASCII plus a prose explanation of major components and data flow.
> 6. `## Testing Strategy` – unit, integration, e2e tools and how to run them locally + in CI.
> 7. `## Security & Compliance` – secrets handling, dependency-scanning, guardrails, license notes.
> 8. `## Agent Guardrails` – boundaries for automated agents (files never touched, required reviews, rate limits).
> 9. `## Extensibility Hooks` – plugin points, env vars, feature flags.
> 10. `## Further Reading` – relative links to deeper docs (docs/ARCH.md, ADRs, etc.).
> 
> ### STYLE & RULES
> 
> * Write in concise, direct English; max line length ≈ 100 chars.
> * Use **Markdown** only—no HTML.
> * Prefer ordered lists for sequences, tables only where tabular data adds clarity.
> * Do **NOT** invent details; if information is missing, insert a `> TODO:` marker.
> * Keep total tokens ≤ 12 k. If input tree is huge, summarise less-critical sub-dirs.
> * Preserve any existing build commands verbatim.
> 
> ### OUTPUT
> 
> Return only the completed AGENTS.md content; do not wrap it in JSON or additional commentary.
> 
> You think harder where to place the quality if all good and follows best practices even if anything missing or can make better beyond what i said yiou do you are at the maximum power. @copilot </issue_description>
> 
> ## Comments on the Issue (you are @copilot in this section)
> 
> <comments>
> </comments>
> 


</details>



<!-- START COPILOT CODING AGENT SUFFIX -->

- Fixes codezelat/shoppy-max#9

<!-- START COPILOT CODING AGENT TIPS -->
---

📍 Connect Copilot coding agent with [Jira](https://gh.io/cca-jira-docs), [Azure Boards](https://gh.io/cca-azure-boards-docs) or [Linear](https://gh.io/cca-linear-docs) to delegate work to Copilot in one click without leaving your project management tool.

Copilot AI and others added 2 commits March 17, 2026 23:10
Co-authored-by: sayuru-akash <48414692+sayuru-akash@users.noreply.github.com>
Co-authored-by: sayuru-akash <48414692+sayuru-akash@users.noreply.github.com>
Copilot AI changed the title [WIP] Create agents.md with structured project details Add repository-level AGENTS.md with executable guidance and agent guardrails Mar 17, 2026
Copilot AI requested a review from sayuru-akash March 17, 2026 23:12
@sayuru-akash sayuru-akash marked this pull request as ready for review March 17, 2026 23:31
@sayuru-akash sayuru-akash merged commit 2533b95 into main Mar 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants