From aff00af05396ea67909d6cb5d9116696234b3ab7 Mon Sep 17 00:00:00 2001 From: ClaydeCode Date: Mon, 24 Aug 2026 12:16:09 +0000 Subject: [PATCH] meta: adopt Scoped Commits and define this repo's scopes Records the commit format in agents.md so it travels with the repo and is found by agents working from a fresh checkout. Co-Authored-By: Claude Opus 5 (1M context) Claude-Session: https://claude.ai/code/session_01TDfmMveB3PoZ46yuy8htr4 --- agents.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/agents.md b/agents.md index 3c71122..c0502b4 100644 --- a/agents.md +++ b/agents.md @@ -59,3 +59,11 @@ Supported via `pymdownx.superfences` custom fence. Use ` ```mermaid ` code block ## Deployment Built and deployed via GitHub Pages (`.github/workflows/ci.yml`). Every push builds with `mkdocs build --strict`; pushes to `main` also deploy. The `site_dir` is `public/`. Site URL: `https://docs.freeshard.net`. + +## Commits + +[Scoped Commits](https://scopedcommits.com/): `: `. The scope is the area of the tree the change touches, never a change type — write `user_guides: document the backup restore flow`, not `fix(user_guides): ...`. Body and trailers are optional; a change's reasoning belongs in the body, not in a code comment. + +Scopes for this repo: `blog` `developer_docs` `user_guides` `overview` `theme` `ci` `meta` + +`meta` covers repo-level files (agents.md, README, justfile). For a change spanning several scopes, use a broader one, list two comma-separated, or use `treewide`. Merges and reverts keep their own format. Don't generate a changelog from the commit log — release notes come from merged PRs.