Skip to content

AGENTS.md

Latest commit

 

History

History
83 lines (50 loc) · 1.96 KB

AGENTS.md

File metadata and controls

83 lines (50 loc) · 1.96 KB

Homebrew Tap — Agent Guidance

Repository

This is a Homebrew tap (everruns/homebrew-tap). Formulae live in Formula/.

Cloud Agent (start here)

Use Doppler for all secret-backed commands in cloud agents.

./scripts/init-cloud-env.sh

All cloud secrets are in Doppler (GITHUB_TOKEN).

For GitHub CLI, map token explicitly:

doppler run -- bash -lc 'GH_TOKEN="$GITHUB_TOKEN" gh auth status'

Style

Telegraph. Drop filler/grammar. Min tokens.

Formulae

  • Each formula is a Ruby file in Formula/
  • Pre-built binary formulae: no depends_on "rust", just bin.install
  • Source-build formulae: use depends_on "rust" => :build and cargo build
  • Always include a test do block

Linting

Run before pushing:

brew audit --strict --new Formula/*.rb

Branch Base

Always work on top of latest main from remote:

git fetch origin main

Commits

Conventional Commits: type(scope): description

Types: feat, fix, docs, chore

NEVER add links to Claude sessions in PR body or commits.

Commit Attribution

All commits MUST be attributed to the real human user, never to a coding agent or bot.

If current git config already resolves to a real human identity, use it as-is.

If current git config is missing or looks agent-like, set GIT_USER_NAME and GIT_USER_EMAIL, then configure git before committing:

git config user.name "$GIT_USER_NAME"
git config user.email "$GIT_USER_EMAIL"
  • Do NOT set GIT_AUTHOR_NAME, GIT_COMMITTER_NAME, or user.name to any AI/bot identity
  • Do NOT use Co-authored-by trailers referencing AI tools
  • Do NOT add "generated by", "authored by AI", or similar attribution in commit messages

Shipping

Ship means: achieve the goal, lint the formula, create a PR, wait for CI green, merge with squash.

Use /ship for the canonical shipping workflow.

CI

GitHub Actions runs brew audit and brew style on every PR. Never merge when CI is red.