Skip to content

Add AGENTS.md for coding agents - #243

Draft
wjohnald wants to merge 1 commit into
mainfrom
add-agents-md
Draft

wjohnald wants to merge 1 commit into
mainfrom
add-agents-md

Conversation

@wjohnald

Copy link
Copy Markdown
Contributor

GEMD Python PR

Description

This PR adds an AGENTS.md file at the repo root. Coding agents of any kind read it for the repo layout, the uv commands, the CI gates, and the code conventions. This PR also adds a CLAUDE.md file that imports AGENTS.md. Claude Code then reads the same guidance.

Reviewers should check the CI gates list against CONTRIBUTING.md and the workflows. Agents rely on two gates most: the version bump in gemd/__version__.py and 100% test coverage.

This PR touches documentation alone, so I left the version as it is. CI may flag that gate.

PR Type:

  • Breaking change (fix or feature that would cause existing functionality to change)
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Maintenance (non-breaking change to assist developers)

Adherence to team decisions

  • I have added tests for 100% coverage
  • I have written Numpy-style docstrings for every method and class.
  • I have communicated the downstream consequences of the PR to others.
  • I have bumped the version in __version__.py

🤖 Generated with Claude Code

AGENTS.md gives coding agents the repo layout, the setup, lint, and test
commands that CI runs, and the conventions a PR must follow. CLAUDE.md
imports it for Claude Code.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

This branch has not been deployed

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant