Skip to content

docs: restructure AGENTS.md to match template format#425

Merged
avoidwork merged 3 commits into
masterfrom
docs/restructure-agents
May 10, 2026
Merged

docs: restructure AGENTS.md to match template format#425
avoidwork merged 3 commits into
masterfrom
docs/restructure-agents

Conversation

@avoidwork
Copy link
Copy Markdown
Owner

Summary

  • Restructure AGENTS.md to match the avoidwork/AGENTS.md template format (sections 1–8 with hierarchical numbering)
  • Add Document Conventions section (1.0) referencing that convention in the template
  • Reorganize existing content under matching section headers: Core Rules, Project Context, Code Conventions, API Conventions, Git Conventions, Operational Rules, Session Learnings, Checklist

@augmentcode
Copy link
Copy Markdown

augmentcode Bot commented May 10, 2026

🤖 Augment PR Summary

Summary: This PR restructures AGENTS.md to follow the avoidwork template format with numbered sections and consistent headings.

Changes:

  • Replaces the prior free-form layout with an 8-section hierarchy (Core Rules → Checklist).
  • Adds a new “Document Conventions” section describing how agents should update the file.
  • Moves project overview, structure, and commands into “Project Context” with an expected layout block.
  • Introduces a quick-commands table for common npm tasks.
  • Groups style/tooling and testing expectations under “Code Conventions”.
  • Organizes the public API notes into an “API Conventions” section.
  • Adds explicit Git conventions (Conventional Commits + branching + review expectations).
  • Moves operational guidance (coverage + common pitfalls + workflow) into a dedicated section.
  • Creates “Session Learnings” and a pre-TODO-completion checklist for repeatable review hygiene.

Technical Notes: This is a documentation-only change intended to standardize agent guidance without altering runtime code.

🤖 Was this summary useful? React with 👍 or 👎

Copy link
Copy Markdown

@augmentcode augmentcode Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review completed. 3 suggestions posted.

Fix All in Augment

Comment augment review to trigger a new review at any time.

Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
Comment thread AGENTS.md
@avoidwork avoidwork merged commit 80d0d46 into master May 10, 2026
4 checks passed
@avoidwork avoidwork deleted the docs/restructure-agents branch May 10, 2026 12:48
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.

1 participant