Skip to content

Commit 665aa13

Browse files
committed
docs: add missing sections to README.md and fix SKILL.md encoding
1 parent 6dbbc3e commit 665aa13

2 files changed

Lines changed: 28 additions & 1 deletion

File tree

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,40 @@ Provides guidance for:
2121
- Writing tests or designing test coverage
2222
- Handling defect fixes or performing root-cause analysis
2323
- Creating test matrices or choosing between unit/integration/E2E tests
24+
- Setting up CI verification or commit hooks
2425

2526
## Installation
2627

2728
```bash
2829
npx skills add metyatech/skill-quality-workflow --yes --global
2930
```
3031

32+
## Usage
33+
34+
Once installed, the skill is automatically triggered by the Gemini CLI when relevant tasks are detected. You can also explicitly reference it by asking about "quality workflow" or "test coverage".
35+
36+
## Development
37+
38+
This repository uses `compose-agentsmd` to manage agent rules.
39+
40+
### Prerequisites
41+
42+
- Node.js (Latest LTS recommended)
43+
- `npm`
44+
45+
### Verification
46+
47+
Run the verification suite to check for linting and formatting issues:
48+
49+
```powershell
50+
npm run verify
51+
```
52+
53+
## Compatibility
54+
55+
- **Agent System**: Gemini CLI, standard Agent Skills runtime.
56+
- **OS**: Cross-platform (Windows, macOS, Linux).
57+
3158
## License
3259

3360
MIT

SKILL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ description: Use when writing tests, designing test coverage, handling defect fi
4141

4242
## Verification evidence procedures
4343

44-
### ACevidence mapping format
44+
### AC->evidence mapping format
4545

4646
- Maintain an explicit mapping: `AC -> evidence (tests/commands/manual steps)`.
4747
- The mapping may be presented in a compact per-item form (one line per AC

0 commit comments

Comments
 (0)