Skip to content

AGENTS.md

Latest commit

 

History

History
72 lines (57 loc) · 2.88 KB

AGENTS.md

File metadata and controls

72 lines (57 loc) · 2.88 KB
Raw

AGENTS.md

Instructions for agents working on shakacode/agent-workflows.

This repo publishes portable agent workflow skills. Keep shared process generic and push repository-specific policy into each consumer repo's AGENTS.md seam.

Agent Workflow Configuration

  • Base branch: main.
  • Pre-push local validation: bin/validate.
  • CI change detector: n/a.
  • Hosted-CI trigger: n/a.
  • CI parity environment: n/a; consumer repos may name an act mapping, runner image, or reproduction guide.
  • Secret redaction patterns: conservative default; consumer repos may define repo-specific CI parity redaction patterns.
  • Benchmark labels: n/a.
  • Follow-up issue prefix: Follow-up:.
  • Changelog: CHANGELOG.md.
  • Lint / format: bin/validate (includes RuboCop) plus Markdown review for changed docs.
  • Merge ledger: n/a.
  • Docs checks: bin/validate and manual link/path review for changed docs.
  • Tests: helper tests invoked by bin/validate.
  • Build / type checks: n/a.
  • Review gate: independent code review for non-trivial workflow or helper changes.
  • Default simplify model: n/a.
  • Approval-exempt change categories: docs, workflow text, helper scripts, skill metadata, and validation fixtures when the change remains portable.
  • Coordination backend: consumer repos choose their backend in their own seam; this repo does not require one.

Editing Rules

  • Keep skills/*/SKILL.md concise and portable.
  • Do not hardcode consumer repo commands, labels, branches, release trackers, or package paths in shared skills.
  • When a workflow needs repo-specific values, name the corresponding AGENTS.md seam key instead of embedding an example command.
  • Keep helper scripts in the skill folder that invokes them, unless the helper is repo-wide like bin/agent-workflow-seam-doctor.
  • Do not add repo-local domain skills here. Domain skills belong in the consumer repo.
  • Keep root documentation user-facing. Do not add extra README files inside individual skill folders.

Validation

Before committing, run:

bin/validate

For changes to a specific helper, run the relevant helper test directly as well. Examples:

ruby skills/pr-batch/bin/pr-security-preflight-test.rb
ruby skills/plan-pr-batch/bin/pr-file-touch-map-test.rb
bash skills/post-merge-audit/bin/post-merge-audit-scope-test.bash

Release And Adoption Notes

This repo is a source pack. Consumers normally install it into an agent home, then validate each consumer checkout with:

agent-workflow-seam-doctor --shared /path/to/agent-workflows

If a consumer repo pins local copies for compatibility, update those copies from this repo and rerun the seam doctor with the pinned copy as --shared. Use agent-workflows-status and upgrade-agent-workflows for installed Codex/Claude homes; see docs/installation-and-upgrades.md.