From 665aa13e810b647d2648be0b1bd3756167124991 Mon Sep 17 00:00:00 2001 From: metyatech Date: Wed, 25 Mar 2026 12:17:35 +0900 Subject: [PATCH] docs: add missing sections to README.md and fix SKILL.md encoding --- README.md | 27 +++++++++++++++++++++++++++ SKILL.md | 2 +- 2 files changed, 28 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d6a2270..4ea1e21 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,7 @@ Provides guidance for: - Writing tests or designing test coverage - Handling defect fixes or performing root-cause analysis - Creating test matrices or choosing between unit/integration/E2E tests +- Setting up CI verification or commit hooks ## Installation @@ -28,6 +29,32 @@ Provides guidance for: npx skills add metyatech/skill-quality-workflow --yes --global ``` +## Usage + +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". + +## Development + +This repository uses `compose-agentsmd` to manage agent rules. + +### Prerequisites + +- Node.js (Latest LTS recommended) +- `npm` + +### Verification + +Run the verification suite to check for linting and formatting issues: + +```powershell +npm run verify +``` + +## Compatibility + +- **Agent System**: Gemini CLI, standard Agent Skills runtime. +- **OS**: Cross-platform (Windows, macOS, Linux). + ## License MIT diff --git a/SKILL.md b/SKILL.md index ebb3c81..a8c02ad 100644 --- a/SKILL.md +++ b/SKILL.md @@ -41,7 +41,7 @@ description: Use when writing tests, designing test coverage, handling defect fi ## Verification evidence procedures -### AC→evidence mapping format +### AC->evidence mapping format - Maintain an explicit mapping: `AC -> evidence (tests/commands/manual steps)`. - The mapping may be presented in a compact per-item form (one line per AC