Skip to content

docs(agents): align AGENTS.md with docs/CONTRIBUTING conventions#470

Merged
mattaereal merged 7 commits intodevelopfrom
update-agents-md-alignment
May 7, 2026
Merged

docs(agents): align AGENTS.md with docs/CONTRIBUTING conventions#470
mattaereal merged 7 commits intodevelopfrom
update-agents-md-alignment

Conversation

@mattaereal
Copy link
Copy Markdown
Collaborator

Summary

Aligns AGENTS.md with template/CONTRIBUTING.md for agent accuracy.

Changes

  • Fix tags example
  • Expand Conventions: frontmatter (title/| SEAL, desc 140-160c, contributors.json), style (AmEng/objective/no full-AI/mermaid/images S3), new pages (vocs.config.tsx), WIP stubs
  • Add unsigned commits rebase/amend workflow

Why

Matches current docs/contributing style/structure.

No other changes.

@mattaereal mattaereal self-assigned this May 4, 2026
@mattaereal mattaereal added local setup Improvements or additions to the local setup enhancement Updates that improve or refine existing features, user experience, or system performance. labels May 4, 2026
Copy link
Copy Markdown
Collaborator

@frameworks-volunteer frameworks-volunteer left a comment

Choose a reason for hiding this comment

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

Model: z-ai/glm-5.1 Reasoning: high Provider: openrouter

Security: clean -- no secrets, injection vectors, or unsafe patterns.

QA: mostly good, a few style nits that contradict the conventions this file aims to document:

  1. Tags/frontmatter examples use YAML flow style (tags: [Engineer/Developer, ...], contributors: [{role: wrote, users: [username]}]) but contributing.md and template.mdx use block style (dashes). Since AGENTS.md is instructing agents to follow conventions, the examples should match the canonical format.

  2. Missing trailing newline -- diff shows \ No newline at end of file.

  3. description: 140-160c -- contributing.md writes "140-160 chars" or "140-160 characters", not "c". Minor but the file should use the repo's own phrasing.

None of these are blocking. Approving with suggestions.

@mattaereal mattaereal force-pushed the update-agents-md-alignment branch from 7ca3ff9 to 71b0997 Compare May 4, 2026 18:59
@cloudflare-workers-and-pages
Copy link
Copy Markdown

cloudflare-workers-and-pages Bot commented May 4, 2026

Deploying frameworks with  Cloudflare Pages  Cloudflare Pages

Latest commit: a6ea9a3
Status: ✅  Deploy successful!
Preview URL: https://47f1e33b.frameworks-573.pages.dev
Branch Preview URL: https://update-agents-md-alignment.frameworks-573.pages.dev

View logs

@mattaereal mattaereal force-pushed the update-agents-md-alignment branch from 71b0997 to 275c36a Compare May 4, 2026 20:49
@mattaereal mattaereal force-pushed the update-agents-md-alignment branch from 275c36a to bfe3647 Compare May 4, 2026 21:27
Copy link
Copy Markdown
Collaborator

@scode2277 scode2277 left a comment

Choose a reason for hiding this comment

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

Left some suggested changes to minimize confusion

Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
Comment thread AGENTS.md
Comment thread AGENTS.md Outdated
mattaereal and others added 5 commits May 5, 2026 17:11
Co-authored-by: Sara Russo <sararusso984@gmail.com>
Co-authored-by: Sara Russo <sararusso984@gmail.com>
Co-authored-by: Sara Russo <sararusso984@gmail.com>
Co-authored-by: Sara Russo <sararusso984@gmail.com>
Co-authored-by: Sara Russo <sararusso984@gmail.com>
Copy link
Copy Markdown
Collaborator

@scode2277 scode2277 left a comment

Choose a reason for hiding this comment

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

gtg now @mattaereal!

@mattaereal mattaereal merged commit 8584ff1 into develop May 7, 2026
3 of 4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement Updates that improve or refine existing features, user experience, or system performance. local setup Improvements or additions to the local setup

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants