Skip to content

Add AGENTS.md and CLAUDE.md, and correct the now-stale copilot-instructions.md #35

Description

@d-morrison

.github/copilot-instructions.md is the only AI-agent config this repo has,
and as of tonight it is wrong. There is no AGENTS.md and no CLAUDE.md.

The gap is already costing review quality

The claude-review bot on #33 said so in its own verdict:

No CLAUDE.md exists anywhere in this repo, so compliance was judged
solely against the SERG lab manual.

Every automated review this repo receives runs without repo-specific context.

copilot-instructions.md is stale

Its "Continuous Integration" section lists lint-changed-files.yaml and
check-spelling.yaml as required checks. Both were removed in #33. It also
predates three conventions that now govern every PR here:

  • version-check inverted: a PR must leave DESCRIPTION's Version:
    alone, and bump-dev-version bumps it after each merge to main. The old
    convention was the opposite, so the file now tells contributors to do the
    one thing that fails CI.
  • There are now two accept-lists with different owners: inst/WORDLIST
    ({spelling}, codepoint-sorted) and _typos.toml (crate-ci/typos).
  • Reusable-workflow callers pin Morrison-Lab/gha@v2, and a caller passing a
    secret the pinned tag does not declare fails at startup with no logs, no
    annotations, and no check run.

Peer repos are configured and this one is not

repo AGENTS.md CLAUDE.md copilot-instructions .claude/settings.json
UCD-SERG/serocalculator yes yes yes yes
ucdavis/bcs yes yes yes yes
Morrison-Lab/gha yes yes -- --
UCD-SERG/serodynamics -- yes yes yes
d-morrison/rme -- yes yes yes
UCD-SERG/shigella -- -- yes --

Proposal

Adopt UCD-SERG/serocalculator's shape rather than ucdavis/bcs's or
Morrison-Lab/gha's: keep .github/copilot-instructions.md as the single
source of truth, and add short orientation files that defer to it.
bcs and gha carry 10--20 KB in each of AGENTS.md and CLAUDE.md, which
triplicates the content and is exactly why one file drifting is expensive.

  1. AGENTS.md -- cross-agent contract (Codex, Cursor, Gemini, opencode).
  2. CLAUDE.md -- Claude Code orientation, deferring to the same source.
  3. .claude/settings.json -- permissions allowlist, as four of the five
    configured peers carry.
  4. Correct the stale CI section and add the three conventions above.

Deferred

Wiring use-ai-config into the two gha bot callers so the reviewer loads the
shared corpus directly. That is the change most likely to improve review
quality, and it alters the behaviour of a currently-working reviewer, so it
wants its own PR and a deliberate decision. Filed separately.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions