Skip to content

Commit 296a880

Browse files
authored
Introduce terminal UX design skill and update documentation (#230)
* feat(#214): introduce terminal UX design skill and instruction - Add terminal UX design skill for PowerShell cmdlets and CLI workflows - Include guidance based on Atlassian's principles and Nielsen's heuristics - Update agent entry points and documentation to reflect new skill * #214 feat: Adding Agentic Copilot workflow to the list of pr affected areas. * fix(#214): expand coverage globs before invoking Pester
1 parent bfdfb77 commit 296a880

24 files changed

Lines changed: 614 additions & 50 deletions

.github/agents/architect.agent.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ Design or reshape changes that cross public commands, private helper boundaries,
3737
## Skills to use
3838

3939
- `/powershell-module-development`
40+
- `/terminal-ux-design`
4041
- `/release-and-changelog`
4142
- `/markdown-authoring`
4243
- `/building-maintainable-code`

.github/agents/powershell-developer.agent.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ Implement PowerShell command and helper changes in the NovaModuleTools style.
3232
## Skills to use
3333

3434
- `/powershell-module-development`
35+
- `/terminal-ux-design`
3536
- `/pester-testing`
3637
- `/building-maintainable-code`
3738
- `/codescene-quality`

.github/agents/reviewer.agent.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ Review changes for correctness, maintainability, test coverage, workflow safety,
4141

4242
## Skills to use
4343

44+
- `/terminal-ux-design`
4445
- `/codescene-quality`
4546
- `/safeguarding-ai-generated-code`
4647
- `/building-maintainable-code`

.github/copilot-instructions.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -37,15 +37,15 @@ For new or not-yet-scoped work, use the `architect` agent with `.github/prompts/
3737

3838
The table below shows how to route work. Prompts are the task entry points; each prompt delegates to its agent, which uses the listed skills, which in turn enforce the listed instructions.
3939

40-
| Task | Prompt | Agent | Primary skills | Primary instructions |
41-
| ----------------------------- | ------------------------------------------ | ---------------------- | ------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------- |
42-
| Design or scope a change | `design-change.prompt.md` | `architect` | `powershell-module-development`, `github-actions`, `release-and-changelog`, `markdown-authoring` | `repository-conventions`, `code-quality-matrix` |
43-
| Implement an issue | `implement-issue.prompt.md` | `powershell-developer` | `powershell-module-development`, `pester-testing`, `building-maintainable-code`, `codescene-quality`, `safeguarding-ai-generated-code` | `repository-conventions`, `code-quality-matrix`, `psscriptanalyzer`, `powershell-coding-standards`, `platyps-help` |
44-
| Review a change | `review-change.prompt.md` | `reviewer` | `codescene-quality`, `safeguarding-ai-generated-code`, `building-maintainable-code`, `docs-site`, `markdown-authoring`, `pester-testing`, `release-and-changelog`, `github-actions` | All `.github/instructions/*.instructions.md` |
45-
| Improve test coverage | `improve-test-coverage.prompt.md` | `test-engineer` | `pester-testing`, `building-maintainable-code`, `codescene-quality`, `github-actions`, `guiding-refactoring-with-code-health`, `safeguarding-ai-generated-code` | `testing-policy`, `psscriptanalyzer` |
46-
| Prepare a release | `prepare-release.prompt.md` | `release-manager` | `release-and-changelog`, `markdown-authoring` | `release-policy`, `repository-conventions` |
47-
| Fix a CI failure | `fix-ci-failure.prompt.md` | `powershell-developer` (or `test-engineer`) | `github-actions`, `pester-testing` | `testing-policy`, `psscriptanalyzer`, `repository-conventions` |
48-
| Update website docs | (no dedicated prompt — invoke agent) | `docs-site` | `docs-site`, `markdown-authoring` | `documentation-separation` |
40+
| Task | Prompt | Agent | Primary skills | Primary instructions |
41+
|--------------------------|--------------------------------------|---------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------|
42+
| Design or scope a change | `design-change.prompt.md` | `architect` | `powershell-module-development`, `terminal-ux-design`, `github-actions`, `release-and-changelog`, `markdown-authoring` | `repository-conventions`, `code-quality-matrix` |
43+
| Implement an issue | `implement-issue.prompt.md` | `powershell-developer` | `powershell-module-development`, `terminal-ux-design`, `pester-testing`, `building-maintainable-code`, `codescene-quality`, `safeguarding-ai-generated-code` | `repository-conventions`, `code-quality-matrix`, `psscriptanalyzer`, `powershell-coding-standards`, `platyps-help` |
44+
| Review a change | `review-change.prompt.md` | `reviewer` | `terminal-ux-design`, `codescene-quality`, `safeguarding-ai-generated-code`, `building-maintainable-code`, `docs-site`, `markdown-authoring`, `pester-testing`, `release-and-changelog`, `github-actions` | All `.github/instructions/*.instructions.md` |
45+
| Improve test coverage | `improve-test-coverage.prompt.md` | `test-engineer` | `pester-testing`, `building-maintainable-code`, `codescene-quality`, `github-actions`, `guiding-refactoring-with-code-health`, `safeguarding-ai-generated-code` | `testing-policy`, `psscriptanalyzer` |
46+
| Prepare a release | `prepare-release.prompt.md` | `release-manager` | `release-and-changelog`, `markdown-authoring` | `release-policy`, `repository-conventions` |
47+
| Fix a CI failure | `fix-ci-failure.prompt.md` | `powershell-developer` (or `test-engineer`) | `github-actions`, `pester-testing` | `testing-policy`, `psscriptanalyzer`, `repository-conventions` |
48+
| Update website docs | (no dedicated prompt — invoke agent) | `docs-site` | `docs-site`, `markdown-authoring` | `documentation-separation` |
4949

5050
## Notation
5151

@@ -61,5 +61,6 @@ The table below shows how to route work. Prompts are the task entry points; each
6161
- PSScriptAnalyzer workflow: `.github/instructions/psscriptanalyzer.instructions.md`
6262
- PowerShell coding standards: `.github/instructions/powershell-coding-standards.instructions.md`
6363
- PlatyPS help generation: `.github/instructions/platyps-help.instructions.md`
64+
- Terminal UX: `.github/instructions/terminal-ux-design.instructions.md` + `terminal-ux-design` skill
6465
- Release flow: `.github/instructions/release-policy.instructions.md` + `release-and-changelog` skill
6566
- Documentation separation: `.github/instructions/documentation-separation.instructions.md` + `docs-site` skill
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
applyTo: "**"
3+
---
4+
5+
# Terminal UX design
6+
7+
Use the `terminal-ux-design` skill when a change touches any user-facing command, terminal output, prompt, help surface, progress indicator, warning, error message, or scaffold guidance for those surfaces.
8+
9+
This applies to:
10+
11+
- PowerShell cmdlets
12+
- `% nova` CLI routes
13+
- private helpers that shape user-visible terminal behavior
14+
- contributor docs, command help, and scaffold content that teach those workflows
15+
16+
Keep PowerShell cmdlet UX and `% nova` CLI UX distinct, but hold both to the same terminal UX bar.
17+
18+
The skill is authoritative for:
19+
20+
- Atlassian's 10 design principles for delightful CLIs
21+
- Jakob Nielsen's 10 usability heuristics for user interface design

.github/pull_request_template.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020
- [ ] Dependency or manifest changes (`project.json`, workflow dependencies, release tooling)
2121
- [ ] Security-sensitive change
2222
- [ ] Documentation-only change
23+
- [ ] Agentic Copilot Workflow + scaffold mirror + scaffold-sync guardrail test.
2324
- [ ] Other
2425

2526
## Review guidance

0 commit comments

Comments
 (0)