Skip to content

Commit 79c1940

Browse files
AndreaV-Lsiclaude
andcommitted
docs: Add GitHub CLI setup instructions and task/issue workflow
- Developer guide: add gh CLI installation (Windows, macOS, Linux) and authentication instructions - CLAUDE.md: document task & issue workflow — draft, confirm, create on GitHub via gh, maintain in tasks/ folder, reference in commits Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent edfb0ad commit 79c1940

2 files changed

Lines changed: 50 additions & 0 deletions

File tree

CLAUDE.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,3 +106,17 @@ tasks/
106106
- **Agnostic mode**: uses `"Tag"` and `"API Compatible Tags"` fields for explicit version control
107107
- **Repository Dictionary** (`$script:RepositoryDictionary`): central tracking structure for all repositories being processed across the dependency tree
108108
- **Immutable config**: once a repo's resolution mode is set, it cannot change during processing
109+
110+
## Task & Issue Workflow
111+
112+
Features, bugs, and enhancements are tracked in `tasks/BACKLOG.md` (planned) and `tasks/DONE.md` (completed), mirroring GitHub issues.
113+
114+
**When the user requests a new feature or reports a bug:**
115+
116+
1. Draft a properly formatted issue description (title + body in GitHub markdown)
117+
2. Ask the user for confirmation before creating
118+
3. Create the issue on GitHub using `gh issue create`
119+
4. Update `tasks/BACKLOG.md` with the issue number and description
120+
5. When implemented, move the entry from `BACKLOG.md` to `DONE.md` with a summary
121+
122+
**When committing a fix or feature**, reference the GitHub issue in the commit message (`Fixes #N` or `Refs #N`)

docs/developer_guide.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,42 @@ OpenSSH is bundled with the OS. LsiGitCheckout uses `GIT_SSH_COMMAND` to specify
144144
chmod 600 key_openssh
145145
```
146146

147+
### GitHub CLI (`gh`)
148+
149+
The GitHub CLI is used to create and manage issues directly from the command line.
150+
151+
**macOS:**
152+
153+
```bash
154+
brew install gh
155+
```
156+
157+
**Windows:**
158+
159+
```cmd
160+
winget install GitHub.cli
161+
```
162+
163+
**Linux (Ubuntu/Debian):**
164+
165+
```bash
166+
sudo apt-get install gh
167+
```
168+
169+
**Authenticate after install:**
170+
171+
```bash
172+
gh auth login
173+
```
174+
175+
Choose **GitHub.com**, **HTTPS**, and **Login with a web browser**. This opens a browser for OAuth — once approved, `gh` stores the token securely.
176+
177+
**Verify:**
178+
179+
```bash
180+
gh auth status
181+
```
182+
147183
### Pester 5.x (Test Framework)
148184

149185
Install the Pester module inside PowerShell 7:

0 commit comments

Comments
 (0)