docs: add contributing and repo agent guidance (#9)
This commit is contained in:
parent
f25874f4df
commit
2aada9a247
|
|
@ -0,0 +1,23 @@
|
||||||
|
# AGENTS.md
|
||||||
|
|
||||||
|
Repo-scope guidance for coding agents.
|
||||||
|
|
||||||
|
## Defaults
|
||||||
|
- Keep diffs small/reviewable.
|
||||||
|
- Preserve existing patterns and naming.
|
||||||
|
- Add regression tests for bug fixes and behavior changes.
|
||||||
|
- Update docs when API/CLI behavior changes.
|
||||||
|
|
||||||
|
## Validation
|
||||||
|
- Run before handoff:
|
||||||
|
- `cargo fmt --all`
|
||||||
|
- `cargo test`
|
||||||
|
- `cargo test --features blocking`
|
||||||
|
|
||||||
|
## Git Safety
|
||||||
|
- Avoid destructive git/file ops unless explicitly requested.
|
||||||
|
- Do not rewrite user changes you did not make.
|
||||||
|
|
||||||
|
## Commits
|
||||||
|
- Commit messages MUST follow Conventional Commits:
|
||||||
|
- https://www.conventionalcommits.org/en/v1.0.0/
|
||||||
|
|
@ -0,0 +1,23 @@
|
||||||
|
# Contributing
|
||||||
|
|
||||||
|
This repository requires Conventional Commits.
|
||||||
|
|
||||||
|
## Commit Message Policy (Required)
|
||||||
|
- All commits MUST follow the Conventional Commits 1.0.0 spec:
|
||||||
|
- https://www.conventionalcommits.org/en/v1.0.0/
|
||||||
|
- Allowed types in this repo:
|
||||||
|
- `feat`, `fix`, `refactor`, `build`, `ci`, `chore`, `docs`, `style`, `perf`, `test`
|
||||||
|
|
||||||
|
Examples:
|
||||||
|
- `feat(client): expose via layer span in typed model`
|
||||||
|
- `fix(cli): parse board-origin --type drill correctly`
|
||||||
|
- `test(client): cover via padstack layer decoding`
|
||||||
|
|
||||||
|
## Before Opening a PR
|
||||||
|
- Run:
|
||||||
|
- `cargo fmt --all`
|
||||||
|
- `cargo test`
|
||||||
|
- `cargo test --features blocking`
|
||||||
|
|
||||||
|
## Maintainer Notes
|
||||||
|
- Proto regeneration workflow lives in `CONTRIBUTIONS.md`.
|
||||||
Loading…
Reference in New Issue