fraXteX / docs /agents /issue-tracker.md
Ayoub
docs(agents): add agent skill configuration
3fa7362
|
Raw History Blame Contribute Delete
2.55 kB
# Issue tracker: Hugging Face Discussions
Issues for this repo live as **Discussions** on the Hugging Face model repo
[`hf.co/ayoubft/fraXteX`](https://hf.co/ayoubft/fraXteX), under its Community tab.
Every issue is referenced by its **discussion number** (e.g. "discussion 12", or `#12`).
When a skill asks for an issue number or issue URL, that is the discussion number or
`https://hf.co/ayoubft/fraXteX/discussions/<number>`.
## Tooling
There is no `gh`-style CLI for Hugging Face Discussions. Use whichever of these fits:
- **Web UI**: the Community tab of the repo. This is the normal path for a human.
- **`huggingface_hub` Python API**, for anything scripted:
```python
from huggingface_hub import HfApi
api = HfApi() # requires a token with write access: `hf auth login`
repo = "ayoubft/fraXteX"
# list
for d in api.get_repo_discussions(repo_id=repo, repo_type="model"):
print(d.num, d.status, d.title)
# read one
d = api.get_discussion_details(repo_id=repo, repo_type="model", discussion_num=12)
# create
api.create_discussion(repo_id=repo, repo_type="model", title="...", description="...")
# comment
api.comment_discussion(repo_id=repo, repo_type="model", discussion_num=12, comment="...")
```
Ask the user before creating or commenting on a discussion: these are public and visible
to anyone who can see the repo.
## When a skill says "publish to the issue tracker"
Create a new discussion with `create_discussion` (or ask the user to open one in the web
UI). The discussion **title** is the issue title; the **description** is the issue body in
markdown. Report the resulting discussion number back to the user.
## When a skill says "fetch the relevant ticket"
Call `get_discussion_details` for the discussion number the user gave you, and read the
title, the opening description, and the comment thread. The user will normally pass the
number directly.
## Triage state
Hugging Face Discussions have **no labels**. Record triage state instead as a line at the
top of a comment on the discussion:
```
Status: ready-for-agent
```
Use the role strings from `triage-labels.md` verbatim. The most recent `Status:` line in
the thread wins. Discussions also carry a native open/closed status (`d.status`); closing
a discussion is the equivalent of `wontfix` or "done", and is a human's call.
## PRs as a request surface
**Off.** Hugging Face pull requests on this repo are not treated as incoming triage items.
Flip this to on if you want agents to read repo PRs as part of the triage queue.