Skip to content

docs: add AGENTS.md #31

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Coding-Dev-Tools wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add AGENTS.md #31

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,5 @@ fixtures/generated/
.ruff_cache/

# Local opencode config
AGENTS.md
.agents/

25 changes: 25 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# API Contract Guardian

## Purpose
CLI tool that monitors OpenAPI schema diffs, detects breaking changes, generates migration guides, and gates CI pipelines on contract violations.

## Build & Test Commands
- Install: `pip install -e .` or `pip install git+https://github.com/Coding-Dev-Tools/api-contract-guardian.git`
- Test: `pytest`
- Lint: `ruff check .`
- Build: `pip wheel . --wheel-dir dist/`

## Architecture
Key directories:
- `src/api_contract_guardian/` — Main package (CLI, diff engine, migration guide generator)
- `tests/` — Test suite
- `.github/workflows/` — CI/CD (4 workflows)

## Conventions
- Language: Python 3.10+
- Test framework: pytest
- CI: GitHub Actions (4 workflows)
- Formatting: ruff (line-length 120)
- Type checking: py.typed included
- Package: setuptools with src layout
- CLI framework: typer