gather-step AGENTS.md

Project instructions for the gather-step workflow, which helps agents collect and review changes in a code repository. They define conventions for commits, Rust checks, formatting, linting, signing, and pull-request reviews.

In plain words
What is it for?
Use them when reviewing a pull request with gather-step or preparing changes in this Rust project, including running checks, formatting code, and creating compliant commits.
Why use it?
They give agents consistent project rules to follow and reduce review or submission errors caused by missed checks, incorrect commit messages, or broken signing settings.

Instructions file for CodexOpenCode

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/thedoublejay/gather-step/agents-md
Clone the repo
git clone --depth 1 https://github.com/thedoublejay/gather-step

Made for: Codex, OpenCode.

Per session 905 This file is loaded in full into every session.
When invoked 905 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00905 $0.00905
Opus 5 $0.00452 $0.00452
Sonnet 5 $0.00181 $0.00181
Haiku 4.5 $0.00090 $0.00090

Measured 2d ago against content hash 80f06824363d, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

gather-step AGENTS.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

AGENTS.md · 45 lines

How it starts

The opening of the file, as written. The whole thing — 45 lines — stays where its author put it; the contents beside it link to each section on GitHub.

AGENTS.md — Gather Step

Memory file for Codex / Gather Step agents. Project conventions and the canonical workflows for this codebase.

Conventions

  • Commit messages: Conventional Commits (feat:, fix:, docs:, refactor:, test:, chore:, etc.). Keep the subject under 72 characters.
  • No trailers: Never add Co-Authored-By or Signed-off-by to commits.
  • Signing: Tests must run cleanly with commit.gpgsign = true set globally. Fixture helpers that create git commits must disable signing locally (e.g., git -c commit.gpgsign=false commit ...) so CI and dev environments that have GPG signing enabled do not break.
  • Lint bar: cargo clippy --workspace --all-targets -- -D warnings must pass clean. No #[allow(clippy::...)] without an #[expect(..., reason = "...")] that explains why.
  • Formatting: cargo fmt --all before committing. rustfmt.toml is the authority.
  • Type-check first: Run cargo check --workspace before submitting any change that touches non-trivial Rust.

Reviewing a PR with gather-step

When the user says "review this PR using gather-step" (or any close variant — "review the PR", "do a structural review with gather-step", etc.):

  1. Run gather-step pr-review --base <base> --head <head> --json to build the review index and emit a structured delta report. Use --keep-cache if the user wants to ask follow-up questions against the review index.
  2. Warn the user before the first run that it will take a minute or two: a fresh review index is being built from scratch in a disposable Gather Step storage. Subsequent runs against the same SHAs may reuse the cache.
  3. Read the report's metadata, safety, changed_files, and suggested_followups. The current schema_version (defined by DELTA_REPORT_SCHEMA_VERSION in crates/gather-step-cli/src/pr_review/delta_report.rs) populates routes, symbols, payload_contracts, events, decorators, contract_alignments, removed_surface_risks, and deployment in addition to the metadata surfaces — none of these are stubs.
  4. For deep follow-ups, run the suggested commands as-is. They include --registry / --storage overrides pointing at the kept review index, so they read the PR-branch state, not the workspace baseline.
  5. Only fall back to manual diff inspection if pr-review is unavailable or fails. Never silently skip it for a structured review request.

Read the full file on GitHub · 45 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 45 lines · 905 tokens per session scan A 80f06824363d

Subscribe to this mod's changes

gather-step AGENTS.md is an instructions file published in the GitHub repository thedoublejay/gather-step (9 stars, last pushed 27d ago), licensed MIT. It adds 905 tokens to every session, about $0.0045 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.

Related

Other instructions, from other repositories

spec-kit AGENTS.md

AGENTS.md instructions for github/spec-kit, covering agents.md, about spec kit and specify, quickstart — add a new integration in 5 steps, integration architecture and integrationmanifest — file tracking.

github/spec-kit · 7,104 tokens

vscode buildNext.instructions.md

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode · 6,785 tokens

codex AGENTS.md

AGENTS.md instructions for openai/codex, covering rust/codex-rs, the codex-core crate, code review rules, crate api surface and model visible context.

openai/codex · 5,182 tokens

langchain AGENTS.md

AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.

langchain-ai/langchain · 4,345 tokens

vscode oss-third-party-notices.instructions.md

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, applying the notice (cutover) and fallback chain (never fail the build).

microsoft/vscode · 5,001 tokens

next.js AGENTS.md

Instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js · 7,296 tokens