Skip to content

Commit c521f21

Browse files
šŸ“[Enhancement]: Add terminal command guidelines and requirement number formatting to documentation
1 parent 57e1cc7 commit c521f21

File tree

2 files changed

+49
-0
lines changed

2 files changed

+49
-0
lines changed

ā€Ž.github/copilot-instructions.mdā€Ž

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,27 @@ PowerShell 7.4+ (GitHub Actions composite actions): Follow standard conventions
2626
- 001-building-on-this: Added PowerShell 7.4+ (GitHub Actions composite actions) + PSModule/GitHub-Script@v1, PSModule/Install-PSModuleHelpers@v1
2727

2828
<!-- MANUAL ADDITIONS START -->
29+
30+
## Terminal Commands
31+
32+
When executing terminal commands (using `run_in_terminal` or similar tools):
33+
- **ALWAYS** prefix shell commands with `pwsh` unless it's a GitHub MCP call
34+
- This applies to all PowerShell scripts, git commands, and other shell operations
35+
- Exception: GitHub MCP Server calls should use their native format without `pwsh` prefix
36+
37+
Examples:
38+
```bash
39+
# Correct - PowerShell script
40+
pwsh -Command "& './.specify/scripts/powershell/setup-plan.ps1' -Json"
41+
42+
# Correct - Git command
43+
pwsh -Command "git status"
44+
45+
# Correct - Any shell command
46+
pwsh -Command "ls -Recurse"
47+
48+
# Exception - GitHub MCP calls (no pwsh prefix)
49+
gh issue create --title "Feature" --body "Description"
50+
```
51+
2952
<!-- MANUAL ADDITIONS END -->

ā€Ž.github/instructions/md.instructions.mdā€Ž

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -163,6 +163,32 @@ Using list when table is better:
163163
- Feature C: Partial - Beta feature
164164
```
165165

166+
## Requirement Number Formatting
167+
168+
When writing or referencing requirement numbers (NFR and FR) in documentation:
169+
- **Always use bold formatting** for requirement numbers
170+
- **Replace hyphens with non-breaking hyphens** (`&#8209;`) between letters and numbers
171+
- This prevents line breaks within requirement numbers and ensures consistent formatting
172+
- This applies to all specification documents, plans, and tables
173+
174+
Examples:
175+
```markdown
176+
# Correct formatting
177+
**NFR&#8209;001**: The system must respond within 200ms
178+
**FR&#8209;042**: User authentication shall support OAuth 2.0
179+
180+
# In tables
181+
| ID | Description |
182+
|----|-------------|
183+
| **NFR&#8209;001** | Performance requirement |
184+
| **FR&#8209;042** | Authentication feature |
185+
186+
# Incorrect formatting (do not use)
187+
NFR-001: Without bold or non-breaking hyphen
188+
**NFR-001**: Bold but with regular hyphen (can break across lines)
189+
NFR&#8209;001: Non-breaking hyphen but not bold
190+
```
191+
166192
## Emphasis
167193

168194
- Use `*` or `_` for emphasis (italic), `**` or `__` for strong emphasis (bold)

0 commit comments

Comments
Ā (0)