Skip to content

Commit 67a8f07

Browse files
committed
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).
1 parent 519f928 commit 67a8f07

1 file changed

Lines changed: 18 additions & 9 deletions

File tree

  • .github/skills/open-github-issue

.github/skills/open-github-issue/skill.md

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name: open-github-issue
33
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".
44
metadata:
55
author: torrust
6-
version: "1.1"
6+
version: "1.2"
77
---
88

99
# Opening a GitHub Issue
@@ -39,7 +39,7 @@ Create the draft under `docs/issues/` using the naming conventions below.
3939
# <Title>
4040

4141
**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>
4343

4444
## Overview
4545

@@ -54,12 +54,14 @@ Create the draft under `docs/issues/` using the naming conventions below.
5454

5555
### Step 2 — Run linters
5656

57+
Use the canonical lint script (see the `run-linters` skill for prerequisites and troubleshooting):
58+
5759
```bash
58-
npx markdownlint-cli2 "**/*.md"
59-
npx cspell --no-progress
60+
./scripts/lint.sh
6061
```
6162

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.
6365

6466
### Step 3 — Human review
6567

@@ -80,14 +82,20 @@ Use the GitHub API/tool to create the issue:
8082
- Note the assigned issue number from the response.
8183
- If opening is canceled or fails, do not invent a number and do not rename the draft file.
8284

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+
8390
### Step 5 — Rename the draft file and update the issue link
8491

8592
```bash
8693
# Move draft to canonical path only after GitHub assigns the number
8794
mv docs/issues/drafts/short-description.md docs/issues/ISSUE-<N>-short-description.md
8895
```
8996

90-
Update the `**Issue**:` line inside the file to a full link:
97+
Update the `**Issue**:` line inside the file to a full link, and update `**Related**:` if it
98+
contains placeholder text:
9199

92100
```markdown
93101
**Issue**: [#<N>](https://github.com/torrust/torrust-tracker-demo/issues/<N>)
@@ -96,13 +104,14 @@ Update the `**Issue**:` line inside the file to a full link:
96104
### Step 6 — Lint again, then commit and push
97105

98106
```bash
99-
npx markdownlint-cli2 "**/*.md"
100-
npx cspell --no-progress
107+
./scripts/lint.sh
101108
```
102109

103110
```bash
111+
# Stage the issue file; also stage project-words.txt if new words were added
104112
git add docs/issues/ISSUE-<N>-short-description.md
105-
git commit -m "docs: add draft issue for <short description>
113+
git add project-words.txt # only if modified
114+
git commit -m "docs: add issue file for <short description>
106115
107116
Refs: #<N>"
108117
git push

0 commit comments

Comments
 (0)