You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs(skills): improve open-github-issue skill with lessons learned
Update open-github-issue skill v1.1 → v1.2 with lessons from practice:
- Steps 2 and 6: replace raw npx commands with ./scripts/lint.sh
(canonical entry point; refer to run-linters skill for details).
- Step 5: remind to update **Related**: placeholder after publication.
- Step 6: stage project-words.txt when new words were added during
linting — previously not mentioned in the commit step.
- Step 4: add guidance on sequential ordering when opening multiple
issues that reference each other.
- Draft template: mark **Related**: as optional (omit if not needed).
- Fix commit message template: "add issue file" not "add draft issue"
(file is renamed out of drafts/ before committing).
Copy file name to clipboardExpand all lines: .github/skills/open-github-issue/skill.md
+18-9Lines changed: 18 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@ name: open-github-issue
3
3
description: Step-by-step process for creating and opening a GitHub issue in the torrust-tracker-demo repository. Use when asked to open, create, or file an issue. Covers writing the draft file, human review, opening on GitHub, renaming the file, and committing. Triggers on "open issue", "create issue", "new issue", "file issue", "draft issue".
4
4
metadata:
5
5
author: torrust
6
-
version: "1.1"
6
+
version: "1.2"
7
7
---
8
8
9
9
# Opening a GitHub Issue
@@ -39,7 +39,7 @@ Create the draft under `docs/issues/` using the naming conventions below.
39
39
# <Title>
40
40
41
41
**Issue**: _(to be filled after publication)_
42
-
**Related**: <links to related issues in this or other repos, if any>
42
+
**Related**: <links to related issues in this or other repos — omit this line entirely if there are none>
43
43
44
44
## Overview
45
45
@@ -54,12 +54,14 @@ Create the draft under `docs/issues/` using the naming conventions below.
54
54
55
55
### Step 2 — Run linters
56
56
57
+
Use the canonical lint script (see the `run-linters` skill for prerequisites and troubleshooting):
58
+
57
59
```bash
58
-
npx markdownlint-cli2 "**/*.md"
59
-
npx cspell --no-progress
60
+
./scripts/lint.sh
60
61
```
61
62
62
-
Fix any errors. Add new project-specific words to `project-words.txt` (one word per line).
63
+
Fix any errors. Add new project-specific words to `project-words.txt` (one word per line, keep the
64
+
file sorted). Re-run the linter after editing `project-words.txt` to confirm the errors are gone.
63
65
64
66
### Step 3 — Human review
65
67
@@ -80,14 +82,20 @@ Use the GitHub API/tool to create the issue:
80
82
- Note the assigned issue number from the response.
81
83
- If opening is canceled or fails, do not invent a number and do not rename the draft file.
82
84
85
+
> **Multiple issues in one session**: when one issue will reference another (e.g. a follow-up
86
+
> issue that links back to a root cause issue), open them in dependency order — open the
87
+
> referenced issue first, record its number, then open the referencing issue with the real link.
88
+
> Never guess or placeholder the number of an issue that has not been opened yet.
89
+
83
90
### Step 5 — Rename the draft file and update the issue link
84
91
85
92
```bash
86
93
# Move draft to canonical path only after GitHub assigns the number
0 commit comments