Skip to content

docs: add AGENTS.md stub #43

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

Merged
petercorke merged 1 commit into from
Aug 17, 2026
Merged

docs: add AGENTS.md stub #43

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
23 changes: 23 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# spatialgeometry — Agent Instructions

Part of the RVC ecosystem. **Read [rvc-ecosystem/AGENTS.md](https://github.com/petercorke/rvc-ecosystem/blob/main/AGENTS.md) first** — it defines shared conventions: repo ownership, math invariants, dependency boundaries, git/PR workflow, code standards, tech-debt tracking. This file only adds what's specific to this repo.

| | |
|---|---|
| PyPI package | `spatialgeometry` |
| Nickname | SG |
| Owner | Jesse Haviland (`jhavl`) — **not Peter Corke** |
| Default branch | `main` |
| Contribution model | **PR only** |

## Notes specific to this repo

- **This is not Peter's repo.** Collaborator push access exists but must never be used —
every change goes through a PR, even trivial docs fixes. If your local clone has a `fork`
remote (Peter's copy) and an `origin` remote (this upstream repo), push branches to `fork`
and open the PR from there. Never push to `origin`.
- Compiles `nanobind` C++ extensions via `scikit-build-core`.
- Depends on `spatialmath` only. `robotics-toolbox-python` and `swift` both depend on this
repo — a breaking API change here has two downstream repos to check.
- Default branch is `main` — this repo has already migrated off `master`; don't assume
otherwise from old references.
Loading