-
Notifications
You must be signed in to change notification settings - Fork 64
docs(agents): align AGENTS.md with docs/CONTRIBUTING conventions #470
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
bfe3647
AGENTS.md initial commit.
mattaereal da203d6
Updates for consistency
mattaereal c8613c9
Update AGENTS.md
mattaereal bba58d6
Update AGENTS.md
mattaereal 6ee5da3
Update AGENTS.md
mattaereal a6ea9a3
Update AGENTS.md
mattaereal e0eb9b7
Update AGENTS.md regarding contributors
mattaereal File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| # AGENTS.md | ||
|
|
||
| ## Workflow | ||
| - Before contributing, see `CODE_OF_CONDUCT.md`. For SEAL Certifications, also see `docs/pages/certs/contributions.mdx`. To take ownership of a framework, see `docs/pages/contribute/stewards`. | ||
| - PRs target `develop` branch. | ||
| - Setup: `pnpm install` | ||
| - Dev server: `pnpm exec just serve` (generators + Vocs on :5173) | ||
| - Build/verify: `pnpm run docs:build` then `pnpm run docs:preview` (preview available on :4173) | ||
| - Lint: `just lint` (cspell + markdownlint on `docs/pages/**/*.mdx`) | ||
| - Devcontainer: `.devcontainer/devcontainer.json` (pre-installs pnpm/Node/tools) | ||
|
|
||
| ## Content Structure | ||
| - New/expanded pages: Copy `docs/pages/config/template.mdx` | ||
| - Frontmatter required: | ||
| ``` | ||
| title: "Page Title | Security Alliance" | ||
| description: "140-160 chars, keywords/action verbs" | ||
| tags: | ||
| - Engineer/Developer | ||
| - Security Specialist | ||
| - Operations & Strategy | ||
| contributors: | ||
| - role: wrote | ||
| users: [username] | ||
| - role: reviewed | ||
| users: [] | ||
| - role: fact-checked | ||
| users: [] | ||
| ``` | ||
| - Sidebar: Update `vocs.config.tsx` items; `dev: true` for WIP (hides on main site) | ||
| - **Never edit**: `index.mdx` files are auto-generated by the build command (do not create or edit manually). | ||
| - Images: do not commit images to the repo. In the PR description (or a PR comment), attach the images and flag that they need uploading. A maintainer or a steward will trigger the `/img-bot` workflow, which uploads to S3 and posts the resulting links back as a PR comment. Then, use those links in the PR content. | ||
| - Generators run on build: tags, indexes, mermaid, printables, certs | ||
|
|
||
| ## Conventions Agents Miss | ||
| - Explain: Non-technical first → technical depth | ||
| - Language: Direct/technical, no 1st person ("implement X" not "I suggest") | ||
| - Playbooks/templates: Top `> 🔑 **Key Takeaway**:` (<40 words summary) | ||
| - Sections: Practical guidance (steps/checklist), Why important (incidents), Pitfalls/examples, Cheat sheet, Further reading | ||
| - Tech details: Balanced (detailed for AWS/Cloudflare/etc., generic timeless principles) | ||
| - Links: Descriptive; Resources section; relative internal paths | ||
| - Frontmatter precision: title: "Page | Security Alliance" (<60 chars or "| SEAL"), description: 140-160 chars (action verbs/keywords like tool names/attacks/standards), contributors: add github username under the appropriate role (wrote|reviewed|fact-checked). First-time contributors must also register a profile in `docs/pages/config/contributors.json` (see "Contributors database" below). | ||
| - Contributors database: first-time contributors must register a profile in `docs/pages/config/contributors.json` keyed by GitHub username. Structure: | ||
| ``` | ||
| "<github-username>": { | ||
| "slug": "<github-username>", | ||
| "name": "<Full Name>", | ||
| "avatar": "https://avatars.githubusercontent.com/<github-username>", | ||
| "github": "https://github.com/<github-username>", | ||
| "twitter": null, | ||
| "website": null, | ||
| "company": null, | ||
| "role": "contributor", | ||
| "job_title": null, | ||
| "description": null, | ||
| "badges": [] | ||
| } | ||
| ``` | ||
| Leave `badges: []` and `role: "contributor"` when self-registering as badges and specific roles are assigned by maintainers. | ||
| - Style: American English; objective/explanatory tone (no simplifications); introduce acronyms; future-proof; no full-AI content (grammar ok); mermaid; images via PR comments → S3 (/img-bot) | ||
| - New pages: MUST update vocs.config.tsx sidebar items (dev: true for WIP) | ||
| - WIP pages: Add stub notice > ⚠️ Stub/in progress, help contribute/expand | ||
|
|
||
| ## Commits/PRs | ||
| - Sign: `git commit -S`; amend unsigned via rebase/edit/amend-S/continue; force-push | ||
| - Pre-PR: Build + preview locally; update contributors.json if new | ||
| - CI enforces: Spellcheck comments PRs, mdlint, preview deploys, vocs-config reminders | ||
| - Unsigned commits fix: git rebase -i HEAD~N; pick→edit; git commit --amend -S --no-edit && git rebase --continue (repeat); git push --force; verify git log --show-signature | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.