docs: commit the agent configuration (AGENTS.md, .agents/skills, .claude symlinks) - #24
Merged
Conversation
goldilocks-ml and goldilocks-core both commit theirs; this repository gitignored it, so anyone but the original developer started here with no project instructions and no skills. The local copy could not be committed as-is: it was a half-adapted copy of goldilocks-core's configuration. AGENTS.md opened with '# goldilocks-core' and described core's Load/Analyse/Advise/Select/Generate pipeline, which does not exist here; github-cli hard-coded --repo stfc/goldilocks-core in about fifteen commands; write-a-test ran --cov=goldilocks_core; write-docs inspected src/goldilocks_core, documented a goldilocks-kmesh CLI, and called a mermaid validator by an absolute path on someone else's machine. AGENTS.md is written for this repository, and records the k-index convention including the per-axis enumeration cap that bounds where the ladder is complete. write-docs is rewritten against the real docs tree. triage is ported from goldilocks-ml. .claude/skills symlinks into .agents/skills so Claude Code and Codex read one source. .gitignore keeps CLAUDE.md local; neither sibling repository has one. Closes #23
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Commits an agent configuration written for this repository, and stops
gitignoring it.
goldilocks-mlandgoldilocks-coreboth commit.agents/andAGENTS.md;this repository listed them in
.gitignore, so anyone other than the originaldeveloper — and any agent — started here with no project instructions and no
skills.
The local copy could not be committed as-is
It was a half-adapted copy of goldilocks-core's configuration:
AGENTS.md# goldilocks-coreand described core'sLoad → Analyse → Advise → Select → Generatepipeline, which does not exist heregithub-cli/SKILL.md--repo stfc/goldilocks-corein ~15 commands, so an agent files issues against the wrong repositorycatchup/SKILL.mdwrite-a-test/SKILL.md--cov=goldilocks_corewrite-docs/SKILL.mdsrc/goldilocks_core, referenceddocs/architecture.md(absent), documented agoldilocks-kmeshCLI (the console script isgoldilocks-data), and invoked a mermaid validator at/home/sigil/.pi/...dft-basics/SKILL.mdWhat is here
AGENTS.md— written for goldilocks-data: the generate/analyse/publishsequence, ecosystem position, the package/campaign boundary ("a private path
must never reach the package API"), the real layout, and the commands from
README.mdincludingruff check src tests campaigns/qe/kpoints/scriptsandthe
--extra aiida --extra kmeshcampaign invocation.It also records the k-index convention, which cost real effort to establish:
k_indexis 0-based with rung 0 the Γ-only(1, 1, 1)mesh; the ladder comesfrom the k-distances where
ceil(|b_i| / k_distance)changes; and theenumeration cap on
nis applied per axis, so the ladder is a complete set ofmeshes only for
k_distance >= max(|b_i|) / n_maxand silently skips reachablemeshes below that. Any recomputed or published
k_indexcolumn must state thecap it used.
.agents/skills/— 12 skills, every goldilocks-core reference corrected.write-docsis rewritten against the real docs tree and now warns that a newpage must be added to the
mkdocs.ymlnav or--strictfails.use-uvgainsan Extras section: AiiDA and pymatgen are optional extras, so an AiiDA import
error usually means a missing
--extra, not a broken environment.triageisported from goldilocks-ml with its ML-specific classification rule replaced by
a campaign/package one.
.claude/skills/<name>— relative symlinks to../../.agents/skills/<name>,stored as git mode
120000, the mechanism goldilocks-ml uses. Codex readsAGENTS.mdand.agents/; Claude Code discovers.claude/skills/; both readthe same files, so they cannot drift.
No
CLAUDE.md— neither sibling repository has one, and.gitignorestillexcludes it. The existing local one pulled all twelve
SKILL.mdfiles intoevery session's context through
@imports; the symlinks do the same jobwithout that cost.
Verification
goldilocks-core/goldilocks_core/goldilocks-kmeshreference and noforeign absolute path survives, except two deliberate ecosystem
cross-references in
AGENTS.mdSKILL.mdCloses #23
Written by an agent on behalf of @junwen94.