melanie witt
2819d1c912
Add an AGENTS.md routing index for AI coding agents, following the pattern established by Nova [1]. The TC discussion on the AGENTS.md community goal [2] concluded that projects should adopt AGENTS.md individually rather than as a mandated goal, so this adds one for openstacksdk. Rather than inlining rules in AGENTS.md, add a "Functional Tests" section to HACKING.rst documenting conventions that apply to both human and AI contributors: one test method per resource, _delete_foo cleanup helpers with addCleanup, failing on misconfigured environments instead of skipping, and testing both admin and non-admin personas. AGENTS.md then serves as a routing index pointing to HACKING.rst and other existing docs. [1] https://review.opendev.org/c/openstack/nova/+/984540 [2] https://review.opendev.org/c/openstack/governance/+/986765 Assisted-by: Claude claude-opus-4-6 claude-code-2.1.232 Change-Id: If01ebab65446ac02e6db698cc4819e7a8c5b40ef Signed-off-by: melanie witt <melwittt@gmail.com>
1.1 KiB
1.1 KiB
AGENTS.md — agent routing index
Agents: explore the repo directly; this file is a routing index, not a contributor guide.
Workflow
For non-trivial planning, inspect deps and tooling:
tox.ini · .pre-commit-config.yaml ·
requirements.txt · test-requirements.txt
Tests: Use tox or stestr; never use pytest.
Routing:
- Style, hacking, checks: HACKING.rst
- Unit test conventions: HACKING.rst (Unit Tests section)
- Functional test conventions: HACKING.rst (Functional Tests section)
- Contributing: CONTRIBUTING.rst
Guardrails
- Tools: Do not install missing tools with a package manager or
pip. - Review: openstacksdk uses Gerrit, not GitHub PRs. Do not create pull requests.
- Commits: Use the
Assisted-By:trailer for AI-assisted contributions per the OpenInfra AI policy. - Git: Read-only operations (
git log,git diff,git status) are fine. Do not run mutating operations (add,commit,reset,push, etc.) unless explicitly instructed.