Skip to content

docs: add TRIGGER_LABELS.md for trigger and help labels (ABCA-1032) #160

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

Open
isadeks wants to merge 1 commit into
base: linear-vercel
Choose a base branch
from
Open

docs: add TRIGGER_LABELS.md for trigger and help labels (ABCA-1032) #160

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
17 changes: 17 additions & 0 deletions docs/TRIGGER_LABELS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Trigger labels

ABCA watches Linear issues for these labels and matches them by name, so you create them yourself (Linear → Settings → Labels, or inline on any issue). Add a short description to each — Linear shows it on hover in the label picker, the only discoverability a first-time teammate gets.

There are exactly two labels:

| Label | What it does | Use it when |
|-------|--------------|-------------|
| `bgagent` | **Do it.** Hands the issue to the agent — it reads the issue, makes the change, and opens a PR. If the issue already has sub-issues, those run in dependency order instead. | The issue is a single, well-defined piece of work (or a parent whose sub-issues are ready). |
| `bgagent:help` | **Explain the labels.** Posts a one-time comment describing what the labels do, then creates no task. Remove it afterward. | You're new to ABCA on this issue and want a reminder of the options. |

Notes:

- The base trigger label defaults to `bgagent`; if you passed `--label <name>` at onboarding, substitute your workspace's label (the `:help` variant follows the same prefix, e.g. `<name>:help`).
- Suggested descriptions to set in Linear: **`bgagent`** — "Hand this issue to ABCA — makes the change and opens a PR"; **`bgagent:help`** — "ABCA explains what its labels do".
- Grouping both under a shared label prefix/group keeps them together and away from unrelated labels in the picker.
- Removing a label does not cancel a running task; use `bgagent cancel <task-id>`.
Loading