harness-everything 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AGENTS.md +2 -0
- package/BENCHMARK_SOP.md +62 -0
- package/CHANGELOG.md +107 -0
- package/Dockerfile +18 -0
- package/LICENSE +201 -0
- package/README.md +197 -0
- package/VERIFICATION.md +347 -0
- package/bin/cli.js +97 -0
- package/build-multi-agent-system/AGENTS.md +50 -0
- package/build-multi-agent-system/README.md +63 -0
- package/build-multi-agent-system/SKILL.md +68 -0
- package/create-agent-launcher/SKILL.md +48 -0
- package/create-agent-launcher/examples/csharp-monorepo.md +123 -0
- package/create-agent-launcher/examples/typescript-cli.md +126 -0
- package/create-agent-launcher/guidelines/platform-claude.md +77 -0
- package/create-agent-launcher/guidelines/platform-codex.md +146 -0
- package/create-agent-launcher/guidelines/platform-copilot.md +74 -0
- package/create-agent-launcher/guidelines/platform-gemini.md +101 -0
- package/create-agent-launcher/guidelines/role-capabilities.md +108 -0
- package/create-agent-launcher/templates/README.md +17 -0
- package/create-agent-launcher/templates/agent-launcher.md +68 -0
- package/create-agent-launcher/templates/backend-developer-csharp.md +56 -0
- package/create-agent-launcher/templates/backend-developer-polyglot.md +62 -0
- package/create-agent-launcher/templates/backend-developer-ts.md +57 -0
- package/create-agent-launcher/templates/memory-keeper.md +37 -0
- package/create-agent-launcher/templates/requirement-analyzer.md +66 -0
- package/create-agent-launcher/templates/specialist-agent.md +34 -0
- package/create-agent-launcher/templates/task-verifier.md +56 -0
- package/create-agent-launcher/templates/tool-maker.md +33 -0
- package/create-agent-launcher/workflows/01-init.md +22 -0
- package/create-agent-launcher/workflows/02-analysis.md +26 -0
- package/create-agent-launcher/workflows/03-generation.md +29 -0
- package/create-agent-launcher/workflows/04-launcher.md +20 -0
- package/docker-verify.sh +266 -0
- package/docs/architecture.md +95 -0
- package/docs/philosophy.md +45 -0
- package/docs/reflection.md +34 -0
- package/docs/routing.md +45 -0
- package/docs/workflows/build-multi-agent-system.md +62 -0
- package/docs/workflows/create-agent-launcher.md +62 -0
- package/docs/workflows/environment-detection.md +63 -0
- package/docs/workflows/eval-harness.md +57 -0
- package/docs/workflows/fable-discipline.md +59 -0
- package/docs/workflows/fable-mode.md +32 -0
- package/docs/workflows/git-commit.md +62 -0
- package/docs/workflows/grill-me.md +62 -0
- package/docs/workflows/grill-with-docs.md +62 -0
- package/docs/workflows/harness-everything.md +92 -0
- package/docs/workflows/improve-codebase-architecture.md +60 -0
- package/docs/workflows/install-cognitive-os.md +60 -0
- package/docs/workflows/repo-docs.md +59 -0
- package/docs/workflows/rewrite-commits.md +60 -0
- package/docs/workflows/security-review.md +58 -0
- package/docs/workflows/self-evolve.md +59 -0
- package/docs/workflows/skill-creator.md +75 -0
- package/docs/workflows/skill-style.md +64 -0
- package/docs/workflows/tdd.md +39 -0
- package/docs/workflows/todo-driven-workflow.md +36 -0
- package/docs/workflows/using-git-worktrees.md +63 -0
- package/docs/workflows/verification-loop.md +69 -0
- package/docs/workflows/verify-before-claim.md +60 -0
- package/docs/workflows/zoom-out.md +62 -0
- package/environment-detection/SKILL.md +77 -0
- package/environment-detection/scripts/preflight.js +93 -0
- package/eval-framework/behavioral-test.js +105 -0
- package/eval-framework/cases/case1.json +5 -0
- package/eval-framework/cases/case2.json +5 -0
- package/eval-framework/cases/case3.json +5 -0
- package/eval-framework/cases/case4-zh-tier2.json +5 -0
- package/eval-framework/cases/case5-zh-tier3.json +5 -0
- package/eval-framework/mechanism-test.js +251 -0
- package/eval-framework/runner.js +56 -0
- package/eval-harness/SKILL.md +59 -0
- package/eval-harness/scripts/evaluate.js +61 -0
- package/fable-discipline/SKILL.md +38 -0
- package/fable-mode/CONTRACT-FORMAT.md +51 -0
- package/fable-mode/SKILL.md +51 -0
- package/fable-mode/agents/fable-orchestrator.md +92 -0
- package/fable-mode/agents/fable-verifier.md +32 -0
- package/fable-mode/agents/fable-worker-haiku.md +48 -0
- package/fable-mode/agents/fable-worker-sonnet.md +49 -0
- package/fable-mode/execution-guardrails/SKILL.md +87 -0
- package/fable-mode/fable-haiku/SKILL.md +48 -0
- package/git-commit/SKILL.md +55 -0
- package/git-commit/guides/ANGULAR_STYLE.md +61 -0
- package/git-commit/guides/COMMIT_GENERATION.md +24 -0
- package/git-commit/guides/LANGUAGE_DETECTION.md +16 -0
- package/git-commit/guides/MAIN_REPO.md +15 -0
- package/git-commit/guides/SUBMODULES.md +27 -0
- package/grill-me/SKILL.md +36 -0
- package/grill-with-docs/ADR-FORMAT.md +47 -0
- package/grill-with-docs/CONTEXT-FORMAT.md +63 -0
- package/grill-with-docs/SKILL.md +99 -0
- package/harness-everything/SKILL.md +141 -0
- package/harness-everything/examples/README.md +9 -0
- package/harness-everything/examples/todo-workflow.md +22 -0
- package/harness-everything/scripts/bootstrap.js +140 -0
- package/harness-everything/scripts/self-heal.js +189 -0
- package/harness-everything/scripts/tier-router.js +219 -0
- package/harness-everything/scripts/todo-cli.js +157 -0
- package/harness-everything/scripts/verify-gate.js +31 -0
- package/hooks/hooks.json +155 -0
- package/hooks/scripts/atomic-commit-check.js +68 -0
- package/hooks/scripts/boundary-guard.js +55 -0
- package/hooks/scripts/context-compact.js +114 -0
- package/hooks/scripts/contract-test.js +79 -0
- package/hooks/scripts/depth-guard.js +65 -0
- package/hooks/scripts/lib/harness-state.js +202 -0
- package/hooks/scripts/lib/platforms/claude.js +42 -0
- package/hooks/scripts/lib/platforms/codex.js +46 -0
- package/hooks/scripts/lib/platforms/continue.js +41 -0
- package/hooks/scripts/lib/platforms/copilot.js +41 -0
- package/hooks/scripts/lib/platforms/cursor.js +41 -0
- package/hooks/scripts/lib/platforms/hermes.js +32 -0
- package/hooks/scripts/lib/platforms/index.js +17 -0
- package/hooks/scripts/lib/platforms/worktrees.js +20 -0
- package/hooks/scripts/reset-circuit-breaker.js +30 -0
- package/hooks/scripts/rule-of-3-tracker.js +91 -0
- package/hooks/scripts/rule-of-3.js +176 -0
- package/hooks/scripts/state-persist.js +99 -0
- package/hooks/scripts/stop-gate.js +80 -0
- package/hooks/scripts/subagent-scope-guard.js +88 -0
- package/improve-codebase-architecture/SKILL.md +44 -0
- package/improve-codebase-architecture/guides/DEEPENING.md +37 -0
- package/improve-codebase-architecture/guides/HTML-REPORT.md +123 -0
- package/improve-codebase-architecture/guides/INTERFACE-DESIGN.md +44 -0
- package/improve-codebase-architecture/guides/LANGUAGE.md +53 -0
- package/install-cognitive-os/SKILL.md +95 -0
- package/package.json +22 -0
- package/repo-docs/SKILL.md +45 -0
- package/repo-docs/templates/agents-template.md +264 -0
- package/repo-docs/templates/knowledge-agents-template.md +50 -0
- package/repo-docs/templates/knowledge-readme-template.md +83 -0
- package/repo-docs/templates/manual-recon.md +117 -0
- package/repo-docs/templates/multi-skills-readme-template.md +72 -0
- package/repo-docs/templates/product-agents-template.md +78 -0
- package/repo-docs/templates/product-readme-template.md +95 -0
- package/repo-docs/templates/readme-template.md +136 -0
- package/repo-docs/templates/single-skill-readme-template.md +70 -0
- package/repo-docs/templates/skills-agents-template.md +60 -0
- package/rewrite-commits/SKILL.md +32 -0
- package/scripts/installer.js +649 -0
- package/scripts/lib/advisory-text.js +163 -0
- package/scripts/lib/claude-hooks.js +71 -0
- package/scripts/lib/gitignore.js +58 -0
- package/scripts/lib/manifest.js +82 -0
- package/scripts/lib/prompts.js +241 -0
- package/scripts/lib/skills.js +172 -0
- package/scripts/lib/workspace.js +28 -0
- package/security-review/SKILL.md +511 -0
- package/self-evolve/SKILL.md +54 -0
- package/self-evolve/scripts/persist-memory.js +40 -0
- package/self-evolve/scripts/self-regression.js +113 -0
- package/skill-creator/SKILL.md +91 -0
- package/skill-creator/references/quality-principles.md +81 -0
- package/skill-creator/references/testing-workflow.md +32 -0
- package/skill-style/SKILL.md +48 -0
- package/skill-style/STYLE.md +37 -0
- package/tdd/SKILL.md +53 -0
- package/tdd/guides/deep-modules.md +33 -0
- package/tdd/guides/interface-design.md +31 -0
- package/tdd/guides/mocking.md +59 -0
- package/tdd/guides/refactoring.md +10 -0
- package/tdd/guides/tests.md +61 -0
- package/todo-driven-workflow/SKILL.md +54 -0
- package/using-git-worktrees/SKILL.md +161 -0
- package/verification-loop/SKILL.md +138 -0
- package/verify-before-claim/SKILL.md +86 -0
- package/zoom-out/SKILL.md +90 -0
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: "product-readme-template"
|
|
3
|
+
description: "README template for end-user products, tools, applications, or platforms. Focuses on the user journey, deployment, and usage rather than source code compilation."
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# {Product Name}
|
|
7
|
+
|
|
8
|
+
> {One-line pitch: What it is and the primary problem it solves.}
|
|
9
|
+
|
|
10
|
+
<!-- Optional: Badges for version, license, status, discord -->
|
|
11
|
+
[](LICENSE)
|
|
12
|
+
|
|
13
|
+
## Overview
|
|
14
|
+
|
|
15
|
+
{2–3 sentences explaining what the product does, who it's for, and why they should care. Focus on the value delivered, not the tech stack.}
|
|
16
|
+
|
|
17
|
+
---
|
|
18
|
+
|
|
19
|
+
## Typical Use Cases
|
|
20
|
+
|
|
21
|
+
- **{Use Case 1}**: {Describe a specific real-world scenario where a user would apply this product to solve a problem.}
|
|
22
|
+
- **{Use Case 2}**: {e.g., "Onboarding: New engineers query the knowledge base instead of reading thousands of commits."}
|
|
23
|
+
|
|
24
|
+
---
|
|
25
|
+
|
|
26
|
+
## Getting Started
|
|
27
|
+
|
|
28
|
+
### Prerequisites
|
|
29
|
+
- {e.g., Docker, Node.js, specific OS requirements}
|
|
30
|
+
- {Any required API keys or external accounts}
|
|
31
|
+
|
|
32
|
+
### Installation / Deployment
|
|
33
|
+
```bash
|
|
34
|
+
# E.g., Docker run command, or download link instructions
|
|
35
|
+
docker run -d -p 8080:8080 my-product/latest
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
### Initial Configuration
|
|
39
|
+
{1-2 steps to configure the bare minimum to get it running, e.g., setting up the `.env` file or initial login.}
|
|
40
|
+
|
|
41
|
+
---
|
|
42
|
+
|
|
43
|
+
## Core Workflow & Features
|
|
44
|
+
|
|
45
|
+
{Walk the user through their first "Aha!" moment. How do they actually use the product?}
|
|
46
|
+
|
|
47
|
+
### 1. {Step One: e.g., Ingestion / Connection}
|
|
48
|
+
{Explanation and command/screenshot}
|
|
49
|
+
|
|
50
|
+
### 2. {Step Two: e.g., Processing / Analysis}
|
|
51
|
+
{Explanation and command/screenshot}
|
|
52
|
+
|
|
53
|
+
### 3. {Step Three: e.g., Querying / Results}
|
|
54
|
+
{Explanation and command/screenshot}
|
|
55
|
+
|
|
56
|
+
---
|
|
57
|
+
|
|
58
|
+
## Concepts & Glossary
|
|
59
|
+
|
|
60
|
+
| Term | Definition |
|
|
61
|
+
|---|---|
|
|
62
|
+
| `{Term 1}` | {Plain English explanation of specific product terminology} |
|
|
63
|
+
| `{Term 2}` | {Explanation} |
|
|
64
|
+
|
|
65
|
+
---
|
|
66
|
+
|
|
67
|
+
## Security & Privacy
|
|
68
|
+
|
|
69
|
+
{Critical for AI or data-heavy products. Explain where data goes, how keys are stored, and if any third-party telemetry or LLM training is involved.}
|
|
70
|
+
|
|
71
|
+
- **Data Locality:** {e.g., Everything runs locally, no code is sent to the cloud except via explicit LLM prompts.}
|
|
72
|
+
- **Credentials:** {e.g., API keys are stored encrypted in the local SQLite database.}
|
|
73
|
+
|
|
74
|
+
---
|
|
75
|
+
|
|
76
|
+
## FAQ & Limitations
|
|
77
|
+
|
|
78
|
+
- **Q: {Common question or error}**
|
|
79
|
+
- **A:** {Solution or workaround}
|
|
80
|
+
|
|
81
|
+
- **Known Limitation:** {e.g., Currently only supports repositories under 2GB.}
|
|
82
|
+
|
|
83
|
+
---
|
|
84
|
+
|
|
85
|
+
## Support & Community
|
|
86
|
+
|
|
87
|
+
- Need help? Open an [Issue](https://github.com/...).
|
|
88
|
+
- Join our community on [Discord/Slack](#).
|
|
89
|
+
|
|
90
|
+
---
|
|
91
|
+
|
|
92
|
+
## For Developers
|
|
93
|
+
|
|
94
|
+
Want to build `{Product Name}` from source or contribute?
|
|
95
|
+
Please see our [Contributing Guide](CONTRIBUTING.md) and the AI instructions in [`AGENTS.md`](AGENTS.md).
|
|
@@ -0,0 +1,136 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: "readme-template"
|
|
3
|
+
description: "Canonical README.md template with archetype-aware section selection."
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# README.md Template
|
|
7
|
+
|
|
8
|
+
Use this as a structural guide. Omit sections gracefully when info isn't available.
|
|
9
|
+
Write in prose — avoid excessive bullets.
|
|
10
|
+
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
## Archetype-Aware Section Selection
|
|
14
|
+
|
|
15
|
+
Choose the section set that matches the repository archetype (from Step 0 of the skill
|
|
16
|
+
workflow). Never leave empty section headings — skip sections that don't apply.
|
|
17
|
+
|
|
18
|
+
| Archetype | Include | Skip |
|
|
19
|
+
|---|---|---|
|
|
20
|
+
| **`code`** | All sections in the full template below | — |
|
|
21
|
+
| **`product`** | See [`product-readme-template.md`](product-readme-template.md) for full layout (Overview, Getting Started, Workflow, FAQ, etc.) | Build, Test, Debugging, Packaging (moved to AGENTS.md) |
|
|
22
|
+
| **`single-skill`**| See [`single-skill-readme-template.md`](single-skill-readme-template.md) for full layout (Usage, Workflow, Constraints, Resources) | Installation, Build, Test, Debugging |
|
|
23
|
+
| **`multi-skills`**| See [`multi-skills-readme-template.md`](multi-skills-readme-template.md) for full layout (Philosophy, Categorized Directory, Workflows) | Installation, Build, Test, Debugging, Packaging |
|
|
24
|
+
| **`courseware`** | Title, Overview, Course Structure, Prerequisites, How to Run Exercises, Contributing, License | Build, Debugging, Packaging |
|
|
25
|
+
| **`docs`** | Title, Overview, Documentation Structure, How to Contribute Docs, Build / Publish (if applicable), License | Test, Debugging, Packaging |
|
|
26
|
+
| **`hybrid`** | Combine applicable columns; add a "What's in this Repo" orientation section first | Empty sections |
|
|
27
|
+
|
|
28
|
+
### Non-code section templates
|
|
29
|
+
|
|
30
|
+
**Skills Index** — for `skills` repos:
|
|
31
|
+
```markdown
|
|
32
|
+
## Skills
|
|
33
|
+
|
|
34
|
+
| Name | Description |
|
|
35
|
+
|---|---|
|
|
36
|
+
| `{skill_name}` | {description from frontmatter} |
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
**Course Structure** — for `courseware` repos:
|
|
40
|
+
```markdown
|
|
41
|
+
## Course Structure
|
|
42
|
+
|
|
43
|
+
| Section | Exercises |
|
|
44
|
+
|---|---|
|
|
45
|
+
| `{XX}-{section-name}` | {exercise names} |
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
**Documentation Structure** — for `docs` repos:
|
|
49
|
+
```markdown
|
|
50
|
+
## Documentation Structure
|
|
51
|
+
|
|
52
|
+
{abbreviated page tree — top-level sections with one-line descriptions}
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
---
|
|
56
|
+
|
|
57
|
+
## Full Template (code archetype)
|
|
58
|
+
|
|
59
|
+
```markdown
|
|
60
|
+
# {project_name}
|
|
61
|
+
|
|
62
|
+
> {one_line_description}
|
|
63
|
+
|
|
64
|
+
<!-- Optional: badges for language, license, CI status -->
|
|
65
|
+
[](LICENSE)
|
|
66
|
+
|
|
67
|
+
## Overview
|
|
68
|
+
|
|
69
|
+
{2–4 sentences explaining what the project does, who it's for, and what problem
|
|
70
|
+
it solves. Write this as a human would, not a spec sheet.}
|
|
71
|
+
|
|
72
|
+
## Prerequisites
|
|
73
|
+
|
|
74
|
+
- {Runtime}: {version} (e.g., Node.js ≥ 20, Python ≥ 3.11)
|
|
75
|
+
- {Any other hard requirements}
|
|
76
|
+
|
|
77
|
+
## Installation
|
|
78
|
+
|
|
79
|
+
```bash
|
|
80
|
+
{package_manager} install
|
|
81
|
+
# or: pip install -e .
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
## Usage
|
|
85
|
+
|
|
86
|
+
```bash
|
|
87
|
+
{primary run command}
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
{One-paragraph description of basic usage, or a short example if helpful.}
|
|
91
|
+
|
|
92
|
+
## Project Structure
|
|
93
|
+
|
|
94
|
+
```
|
|
95
|
+
{abbreviated tree — top-level dirs only, one-line description each}
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
## Development
|
|
99
|
+
|
|
100
|
+
### Running tests
|
|
101
|
+
|
|
102
|
+
```bash
|
|
103
|
+
{test command}
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
### Linting & formatting
|
|
107
|
+
|
|
108
|
+
```bash
|
|
109
|
+
{lint command}
|
|
110
|
+
{format command}
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
### Building
|
|
114
|
+
|
|
115
|
+
```bash
|
|
116
|
+
{build command}
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
## Contributing
|
|
120
|
+
|
|
121
|
+
{Brief note or link to CONTRIBUTING.md. One or two sentences is enough.}
|
|
122
|
+
|
|
123
|
+
## License
|
|
124
|
+
|
|
125
|
+
{License name} — see [LICENSE](LICENSE) for details.
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
---
|
|
129
|
+
|
|
130
|
+
## Style notes
|
|
131
|
+
|
|
132
|
+
- Use `##` for top-level sections (not `#`)
|
|
133
|
+
- Code blocks must specify language: ` ```bash `, ` ```ts `, etc.
|
|
134
|
+
- Don't add sections you can't populate — an empty section is worse than no section
|
|
135
|
+
- Keep the Overview honest — don't oversell
|
|
136
|
+
- Version numbers must match what's in the config files exactly
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: "single-skill-readme-template"
|
|
3
|
+
description: "README template for a repository that hosts a single, complex AI skill. Focuses on usage, workflows, generated artifacts, and supplementary resources."
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# {Skill Name}
|
|
7
|
+
|
|
8
|
+
> {One-line description from SKILL.md YAML frontmatter}
|
|
9
|
+
|
|
10
|
+
<!-- Optional: Badges for version, license, status -->
|
|
11
|
+
[](LICENSE)
|
|
12
|
+
|
|
13
|
+
## Overview
|
|
14
|
+
|
|
15
|
+
{2–3 sentences explaining what this skill does, what problem it solves, and why a user would invoke it.}
|
|
16
|
+
|
|
17
|
+
---
|
|
18
|
+
|
|
19
|
+
## Usage
|
|
20
|
+
|
|
21
|
+
Invoke the skill in GitHub Copilot Chat (or your preferred AI agent) with a prompt like:
|
|
22
|
+
|
|
23
|
+
- "{Trigger phrase 1 from description}"
|
|
24
|
+
- "{Trigger phrase 2}"
|
|
25
|
+
- "{Trigger phrase 3}"
|
|
26
|
+
|
|
27
|
+
---
|
|
28
|
+
|
|
29
|
+
## How it Works (Workflow)
|
|
30
|
+
|
|
31
|
+
When invoked, the skill automatically executes the following steps:
|
|
32
|
+
|
|
33
|
+
1. **{Step 1 Title}**: {Brief human-readable summary of what the AI does first}
|
|
34
|
+
2. **{Step 2 Title}**: {Summary of the next action}
|
|
35
|
+
3. **{Step 3 Title}**: {Summary of the next action}
|
|
36
|
+
|
|
37
|
+
*(See the `SKILL.md` file for the exact machine-readable instructions.)*
|
|
38
|
+
|
|
39
|
+
---
|
|
40
|
+
|
|
41
|
+
## Key Rules & Constraints
|
|
42
|
+
|
|
43
|
+
- **{Constraint 1}**: {e.g., "All submodules must be fully processed before the main repository."}
|
|
44
|
+
- **{Constraint 2}**: {e.g., "Existing files are never overwritten without explicit confirmation."}
|
|
45
|
+
|
|
46
|
+
---
|
|
47
|
+
|
|
48
|
+
## Resources & File Structure
|
|
49
|
+
|
|
50
|
+
This skill utilizes supplementary context files to guide the AI's behavior:
|
|
51
|
+
|
|
52
|
+
```
|
|
53
|
+
.
|
|
54
|
+
├── SKILL.md # Core AI instructions and workflow definition
|
|
55
|
+
├── {supplementary_file.md} # {Brief description of what this file provides to the AI}
|
|
56
|
+
├── examples/
|
|
57
|
+
│ └── {example_file.md} # {Description of the example}
|
|
58
|
+
└── guidelines/
|
|
59
|
+
└── {guideline_file.md} # {Description of the guideline}
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
---
|
|
63
|
+
|
|
64
|
+
## Contributing
|
|
65
|
+
|
|
66
|
+
Open a PR to update the core workflow in `SKILL.md`, or to add new edge cases to the `examples/` directory.
|
|
67
|
+
|
|
68
|
+
## License
|
|
69
|
+
|
|
70
|
+
Apache 2.0 — see [LICENSE](LICENSE) for details.
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: "skills-agents-template"
|
|
3
|
+
description: "AGENTS.md template acting as a Meta-Authoring Guide for AI agents working within a single-skill or multi-skills repository. Enforces structure, frontmatter schemas, and extension rules."
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# {Project Name} - AI Authoring Guide
|
|
7
|
+
|
|
8
|
+
> This repository hosts AI skills. This document serves as a Meta-Authoring Guide, dictating how AI agents should scaffold, modify, or extend these skills without breaking the project's structure.
|
|
9
|
+
|
|
10
|
+
## Directory Structure & Taxonomy
|
|
11
|
+
|
|
12
|
+
Respect the semantic boundaries of the following directories:
|
|
13
|
+
|
|
14
|
+
| Directory | Purpose / Rules |
|
|
15
|
+
|---|---|
|
|
16
|
+
| `{skills_dir}/` | **(For Multi-Skills only)** Every skill MUST live in its own dedicated subfolder under a specific category (e.g., `skills/engineering/new-skill/`). Do not place `SKILL.md` directly in the root of `skills/`. |
|
|
17
|
+
| `examples/` | Supplementary markdown files providing few-shot examples or expected outputs for the agent. **Do not put executable code here.** |
|
|
18
|
+
| `guidelines/` | Rules or boundaries that constrain the AI's behavior when executing the skill. |
|
|
19
|
+
| `scripts/` | Utility scripts for linting, testing, or packing the skills. |
|
|
20
|
+
|
|
21
|
+
## How to Extend (Scaffolding a New Skill)
|
|
22
|
+
|
|
23
|
+
When asked by the user to create or add a new skill to this repository, you **MUST strictly follow this procedure**:
|
|
24
|
+
|
|
25
|
+
### 1. Determine Location
|
|
26
|
+
- **Single-Skill Repo**: You are likely modifying the root `SKILL.md`.
|
|
27
|
+
- **Multi-Skills Repo**: Choose an existing category folder (e.g., `engineering/` or `productivity/`) and create a new kebab-case folder for the skill: `mkdir skills/{category}/{new-skill-name}`.
|
|
28
|
+
|
|
29
|
+
### 2. Write `SKILL.md`
|
|
30
|
+
Generate the core file. It MUST include:
|
|
31
|
+
- A YAML frontmatter block (see schema below).
|
|
32
|
+
- A `## Core Rules` or `## Constraints` section.
|
|
33
|
+
- A `## Workflow` section detailing the exact execution steps.
|
|
34
|
+
|
|
35
|
+
### 3. Provide Resources (Optional but Recommended)
|
|
36
|
+
If the skill is complex, do not stuff everything into `SKILL.md`.
|
|
37
|
+
- Create an `examples/{scenario}.md` file to show what good output looks like.
|
|
38
|
+
- Reference this file in the `SKILL.md` prompt.
|
|
39
|
+
|
|
40
|
+
### 4. Post-processing
|
|
41
|
+
If the repository contains an index-generation script (e.g., `scripts/list-skills.sh` or `scripts/link-skills.sh`), execute it after saving your files to ensure the README remains up to date.
|
|
42
|
+
|
|
43
|
+
---
|
|
44
|
+
|
|
45
|
+
## Frontmatter Schema
|
|
46
|
+
|
|
47
|
+
Every `SKILL.md` MUST begin with this exact YAML structure:
|
|
48
|
+
|
|
49
|
+
```yaml
|
|
50
|
+
---
|
|
51
|
+
name: "{skill-name}" # Must be kebab-case, matching the folder name (if applicable).
|
|
52
|
+
description: > # A 1-2 sentence description including the trigger phrase or exact use case.
|
|
53
|
+
Use when ...
|
|
54
|
+
---
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
## Constraints & Gotchas
|
|
58
|
+
|
|
59
|
+
- **Variables**: Never use single braces `{}` for variables in prompts, as they might conflict with code snippets. Always use double braces `{{VARIABLE}}`.
|
|
60
|
+
- **Formatting**: Keep instructions terse and directive. Use bullet points and bold text for emphasis. Do not use marketing language.
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: rewrite-commits
|
|
3
|
+
description: Cleans, squashes, or rewrites past Git history to comply with Angular Style conventions safely.
|
|
4
|
+
author: Miya Daniel | Harness Core Team
|
|
5
|
+
version: 0.2.0
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# Rewrite Commits
|
|
9
|
+
|
|
10
|
+
## 📋 Skill Contract
|
|
11
|
+
|
|
12
|
+
| Component | Specification |
|
|
13
|
+
| :--- | :--- |
|
|
14
|
+
| **Trigger / Input** | User requests cleaning, squashing, or rewriting past Git history to comply with Angular Style conventions. |
|
|
15
|
+
| **Expected Output** | A rewritten, Angular-Style-compliant commit history on a temporary branch, confirmed against `git log --oneline` before being treated as final. |
|
|
16
|
+
| **State Mutations** | Rewrites local Git history (via `git rebase -i` or equivalent) on a temp branch first — never in place on the target branch. |
|
|
17
|
+
| **Enforcement Gate** | If any target commit has already been pushed to `main`/`master`, **MUST** warn the human and get explicit secondary confirmation before executing. A merge conflict during rebase **MUST** stop execution immediately and hand off to the human or `zoom-out` — no forced resolution. |
|
|
18
|
+
|
|
19
|
+
Triggered when the user requests to clean, squash, or rewrite past Git history to comply with the team's Angular Style conventions.
|
|
20
|
+
|
|
21
|
+
## 1. Environment Discovery `[Discover]`
|
|
22
|
+
- First, execute `git log --oneline -n <num>` to confirm the range of history the user wants to rewrite.
|
|
23
|
+
- **Safety Circuit Breaker**: If the modified commits have already been pushed to the remote `main` or `master` branch, you MUST warn the user: "Rewriting pushed history may cause team conflicts", and require secondary human confirmation before executing.
|
|
24
|
+
|
|
25
|
+
## 2. Execution Process `[Think] & [Try]`
|
|
26
|
+
- Create a temporary branch (Temp Branch) to perform history rewriting to avoid breaking the original history.
|
|
27
|
+
- Use interactive rebase (`git rebase -i`) paired with environment tools, or aggregate past changes into single/multiple clean Commits.
|
|
28
|
+
- The rewritten commit messages MUST fully comply with the Angular Style conventions in the `git-commit` skill.
|
|
29
|
+
|
|
30
|
+
## 3. Completion and Validation `[Summarize]`
|
|
31
|
+
- Once rewriting is complete, execute `git log --oneline` to let the user confirm the new history tree.
|
|
32
|
+
- If a Merge Conflict occurs, STOP immediately, hand over to human decision, or trigger `zoom-out` to seek guidance.
|