Skip to content

Adopt AGENTS.md as the canonical brief for AI coding tools - #22

Merged
ChrisonSimtian merged 2 commits into
developfrom
docs/adopt-agents-md
Aug 16, 2026
Merged

Adopt AGENTS.md as the canonical brief for AI coding tools#22
ChrisonSimtian merged 2 commits into
developfrom
docs/adopt-agents-md

Conversation

@ChrisonSimtian

Copy link
Copy Markdown
Contributor

Brings this repo onto the framework's convention: one canonical AGENTS.md, read natively by GitHub Copilot, with CLAUDE.md as a pointer that imports it.

Changes

  • AGENTS.md — canonical brief: repo layout, the build/plugin split, commands, and the ten rules that aren't discoverable from the code (generated build.yml, the build-skip.yml complement, the version/framework-line assertion, marketplace version constraints).
  • CLAUDE.md — five-line pointer, same shape as the framework's.
  • CONTRIBUTING.md — contributor flow, plus a "things that will fail review" list.
  • docs/issue-and-pr-style.md — style contract both agent configs bind to, rather than duplicating the rules in each.
  • .github/ISSUE_TEMPLATE/ — bug, feature, story, config. The bug form leads with the two checks that account for most reports: Fallout 10.4.0+, and a build-graph.json that exists.
  • .claude/ — shared config, adapted not copied. restructure-pr-commits gained a step 0: PRs into develop are squashed, so curating their commits is wasted effort, and it now reads the PR's real base ref before doing anything.
  • .gitignore*.local.*, so machine-local state (CLAUDE.local.md, settings.local.json) can't be committed.
  • .vscodeignore — keeps all of the above out of the .vsix.

Notes

None of the added files are in version.json's pathFilters, so this doesn't move the git height.

.claude/settings.json is deliberately absent — it's a Bash permission allowlist and should be a human decision.

Mirrors the framework repo's convention so contributors and tooling meet one
shape across both: AGENTS.md is the single canonical brief, read natively by
GitHub Copilot, and CLAUDE.md is a pointer that imports it.

Brings across the rest of that convention, adapted rather than copied — the
merge model differs here, so the commit-restructuring skill now checks the PR's
base branch first and stops on develop-bound PRs, where squash makes commit
curation pointless.

Issues gain templates. The bug form leads with the two checks that account for
most reports: Fallout 10.4.0+, and a build-graph.json that actually exists.

*.local.* is ignored by convention — machine-local state, never committed.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@ChrisonSimtian ChrisonSimtian added the documentation Improvements or additions to documentation label Aug 16, 2026
Both now live once in Fallout-build/.github rather than in each repository, so
the previous link into the framework repo's copy would have 404'd.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@ChrisonSimtian
ChrisonSimtian merged commit aa2dedb into develop Aug 16, 2026
2 checks passed
@ChrisonSimtian
ChrisonSimtian deleted the docs/adopt-agents-md branch August 16, 2026 00:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant