Add agent notes, coding standards, and the issue tracker
This commit is contained in:
1 parent
4ddeba5402
commit
a9ac51bd43
4 files changed
+142
-8
No files matched your search
@@ -0,0 +1,40 @@
|
||||
# Issue tracker
|
||||
|
||||
The tracker is the Gitea instance at https://git.tanshu.com/tanshu/playbooks.
|
||||
Issues live under the Issues tab of that repository.
|
||||
|
||||
## Fetching an issue
|
||||
|
||||
Set a token once. Create one at https://git.tanshu.com/user/settings/applications
|
||||
with the `read:issue` scope.
|
||||
|
||||
export GITEA_TOKEN=...
|
||||
|
||||
Then read one issue and its comments:
|
||||
|
||||
curl -s -H "Authorization: token $GITEA_TOKEN" \
|
||||
https://git.tanshu.com/api/v1/repos/tanshu/playbooks/issues/123
|
||||
|
||||
curl -s -H "Authorization: token $GITEA_TOKEN" \
|
||||
https://git.tanshu.com/api/v1/repos/tanshu/playbooks/issues/123/comments
|
||||
|
||||
The JSON carries `title` and `body`. Pass those to the spec reviewer.
|
||||
|
||||
## Finding the issue for a change
|
||||
|
||||
Commit messages reference issues as `#123`. Check the commits under review:
|
||||
|
||||
git log --oneline origin/main..HEAD
|
||||
|
||||
If no message references an issue, ask the user for the issue number. Do not
|
||||
guess.
|
||||
|
||||
## Specs without an issue
|
||||
|
||||
Larger changes use a plan in `docs/` instead of an issue. The Podman migration
|
||||
plan is `docs/podman-migration.md`. Section 8 lists the repo changes it expects.
|
||||
|
||||
## Private or missing tracker
|
||||
|
||||
If the host is unreachable or the token is absent, say so and fall back to a spec
|
||||
file under `docs/`. Do not invent requirements.
|
||||
Reference in new issue
Block a user