agentleFS
docxologydocxology/codomyrmex/.github/AGENTS.md

codomyrmex

AGENTS.md10 starsChanged 38 days agoMITView on GitHub

Status: Active | Last Updated: April 2026 This directory holds GitHub-specific configuration: CI/CD workflows, issue/PR templates, Dependabot config, CODEOWNERS, Gemini AI command configs, and multi-agent infrastructure. This document tells AI agents what they need to know to operate safely within this directory. Workflow YAML count: 37 files under .github/workflows/ (align with root README.md and docs/reference/inventory.md; refresh via uv run python scripts/doc_inventory.py).

The file

We split this AGENTS.md into the rules it gives an agent

9 rules. About 0 are common, 2 are distinctive, and 7 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈2

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 7

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Read any file in .github/ to understand CI/CD structure and triggers

    line 77
  2. Very specific:

    Run yamllint .github/workflows/*.yml to validate YAML syntax

    line 78
  3. Very specific:

    Use gh run list --workflow=<name>.yml and gh run view to check status

    line 79
  4. Very specific:

    Use gh pr list and gh issue list to review open items

    line 80
  5. Very specific:

    Read CODEOWNERS to understand review assignment rules

    line 81
  6. Distinctive:

    Read the target workflow file fully before editing

    line 92
  7. Very specific:

    Keep concurrency: groups intact

    line 94
  8. Very specific:

    Use uv (not pip/poetry) for Python dependency management

    line 96
  9. Distinctive:

    Test workflow changes on a feature branch before merging to main

    line 97

≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
AGENTS.md

.github -- AI Agent Guide

Status: Active | Last Updated: April 2026

Purpose

This directory holds GitHub-specific configuration: CI/CD workflows, issue/PR templates, Dependabot config, CODEOWNERS, Gemini AI command configs, and multi-agent infrastructure. This document tells AI agents what they need to know to operate safely within this directory.

Workflow YAML count: 37 files under .github/workflows/ (align with root README.md and docs/reference/inventory.md; refresh via uv run python scripts/doc_inventory.py).

Directory Contents

PathPurpose
workflows/ci.ymlContinuous integration: lint, coverage-gate (full tests, 60% cov), Unix full-suite matrix, blocking Windows portability matrix, build
workflows/pre-commit.ymlPre-commit hook validation and commit message checks (soft-fail for agents)
workflows/security.ymlDaily + push-triggered security scanning (6 scanners)
workflows/release.ymlTag-triggered release: quality gate (60% pytest cov), build, PyPI publish, stable-release documentation PR
workflows/documentation.ymlDoc build and deploy on doc-file changes
workflows/documentation-validation.ymlLink checking, structure validation (PR + weekly)
workflows/benchmarks.ymlPerformance regression tracking (push main + weekly)
workflows/maintenance.ymlStale issue/PR handling (90d for PRs, jules-exempt), cleanup, metrics
workflows/workflow-coordinator.ymlSmart path-based selective workflow triggering
workflows/workflow-status.ymlAggregated status dashboard after workflow completions
workflows/code-health.ymlWeekly code health dashboard with coverage trends
workflows/auto-merge.ymlSquash-merge for PRs a reviewer labelled auto-merge (eligibility: scripts/maintenance/auto_merge_eligible.py)
workflows/cleanup-branches.ymlWeekly cleanup of merged + stale branches
workflows/pr-labeler.ymlAuto-labels PRs by paths, branch name, size, and module
workflows/pr-conflict-check.ymlScans open PRs for merge conflicts every 6 hours
workflows/jules-dispatch.ymlBatch dispatch Jules tasks as GitHub issues
workflows/agent-welcome.ymlAgent-specific PR welcome messages with checklists
workflows/agent-metrics.ymlWeekly agent PR/issue/workflow health dashboard
workflows/lock-threads.ymlLock old closed issues (90d) and PRs (60d)
workflows/gemini-*.ymlGemini AI-assisted review, triage, dispatch (5 workflows)
ISSUE_TEMPLATE/Structured issue forms: bug, feature, docs, Jules task
commands/Gemini AI command .toml configs for PR review and triage
CODEOWNERSCode ownership mapping (@docxology)
dependabot.ymlAutomated dependency update configuration (3 ecosystems)
PULL_REQUEST_TEMPLATE.mdConcise agent-friendly PR template (27 lines)

Agent-Specific Infrastructure

Jules AI Agent

FeatureWorkflowDetails
Auto-labelingpr-labeler.ymlLabels by branch name, paths, size, module
Auto-mergeauto-merge.ymlSquash-merge when checks pass + auto-merge label
Welcome messageagent-welcome.ymlPosts checklist comment on new Jules PRs
Batch dispatchjules-dispatch.ymlCreates issues for each module from templates
Issue templateISSUE_TEMPLATE/jules_task.ymlPre-configured with all 28+ modules
Stale exemptionmaintenance.ymlJules PRs exempt from stale closure
Conflict detectionpr-conflict-check.ymlAuto-labels conflicting PRs every 6h
Metricsagent-metrics.ymlWeekly dashboard of Jules PR/issue counts

Gemini CLI Agent

FeatureWorkflowDetails
PR reviewgemini-review.ymlAutomated code review on PR open
Issue triagegemini-triage.ymlAuto-triage on issue open/reopen
Dispatchgemini-dispatch.ymlRoutes @gemini-cli commands
Scheduled triagegemini-scheduled-triage.ymlPeriodic batch triage
Invocationgemini-invoke.ymlManual Gemini invocation

Dependabot

FeatureDetails
Auto-labelingpr-labeler.yml adds dependencies + automated (never auto-merge)
Auto-mergeauto-merge.yml merges when checks pass

Safe Operations

  • Read any file in .github/ to understand CI/CD structure and triggers
  • Run yamllint .github/workflows/*.yml to validate YAML syntax
  • Use gh run list --workflow=<name>.yml and gh run view to check status
  • Use gh pr list and gh issue list to review open items
  • Read CODEOWNERS to understand review assignment rules

Caution Required

  • Workflow edits take effect immediately on the next trigger — test on a branch
  • CODEOWNERS changes affect review requests for every future PR
  • Never remove permissions: {} blocks — they enforce least-privilege tokens
  • Never remove concurrency: blocks — they prevent duplicate workflow runs

Modifying Workflows — Checklist

  1. Read the target workflow file fully before editing
  2. Preserve all permissions: blocks (deny-all default + job-level grants)
  3. Keep concurrency: groups intact
  4. Pin action versions to a full commit SHA with a trailing comment naming the release, e.g. uses: actions/checkout@<40-char sha> # actions/checkout@vX.Y.Z (CUR-4, CUR-5)
  5. Use uv (not pip/poetry) for Python dependency management
  6. Test workflow changes on a feature branch before merging to main
  7. Validate YAML: python3 -c "import yaml; yaml.safe_load(open('file.yml'))"

CI Quick Commands

# List recent CI runs
gh run list --workflow=ci.yml --limit=5

# Check auto-merge status
gh run list --workflow=auto-merge.yml --limit=3

# List agent PRs
gh pr list --label=jules --state=open

# List conflicting PRs
gh pr list --label=conflict --state=open

# View agent metrics (latest run)
gh run list --workflow=agent-metrics.yml --limit=1

# Trigger Jules batch dispatch
gh workflow run jules-dispatch.yml -f modules=all -f task_template=docstrings-mcp-tests

Operating Contracts

ContractRequirement
Workflow top-level permissionsMust be permissions: {} (deny-all)
Job-level permissionsGrant only what the job needs
Action pinningFull commit SHA with a trailing comment naming the release; never a tag, @main or @latest (CUR-4, CUR-5)
ConcurrencyEvery workflow must have a concurrency: block
Python toolingUse uv for all dependency management
Test coverageCI enforces 60% minimum (pyproject.toml)
Security scanning6 independent scanners must remain active
Agent PR handlingAuto-label → CI → auto-merge pipeline

Currency and supply chain

Account rules CUR-1..CUR-16 are authoritative for this repository; where this file and those rules disagree, the rules win.

Navigation

  • PAI.md | SPEC.md
  • Root AGENTS | Root PAI

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.