mirror of
https://github.com/NousResearch/hermes-agent.git
synced 2026-04-28 06:51:16 +08:00
Generates a full dedicated Docusaurus page for every one of the 132 skills
(73 bundled + 59 optional) under website/docs/user-guide/skills/{bundled,optional}/<category>/.
Each page carries the skill's description, metadata (version, author, license,
dependencies, platform gating, tags, related skills cross-linked to their own
pages), and the complete SKILL.md body that Hermes loads at runtime.
Previously the two catalog pages just listed skills with a one-line blurb and
no way to see what the skill actually did — users had to go read the source
repo. Now every skill has a browsable, searchable, cross-linked reference in
the docs.
- website/scripts/generate-skill-docs.py — generator that reads skills/ and
optional-skills/, writes per-skill pages, regenerates both catalog indexes,
and rewrites the Skills section of sidebars.ts. Handles MDX escaping
(outside fenced code blocks: curly braces, unsafe HTML-ish tags) and
rewrites relative references/*.md links to point at the GitHub source.
- website/docs/reference/skills-catalog.md — regenerated; each row links to
the new dedicated page.
- website/docs/reference/optional-skills-catalog.md — same.
- website/sidebars.ts — Skills section now has Bundled / Optional subtrees
with one nested category per skill folder.
- .github/workflows/{docs-site-checks,deploy-site}.yml — run the generator
before docusaurus build so CI stays in sync with the source SKILL.md files.
Build verified locally with `npx docusaurus build`. Only remaining warnings
are pre-existing broken link/anchor issues in unrelated pages.
361 lines
10 KiB
Markdown
361 lines
10 KiB
Markdown
---
|
|
title: "Test Driven Development — Use when implementing any feature or bugfix, before writing implementation code"
|
|
sidebar_label: "Test Driven Development"
|
|
description: "Use when implementing any feature or bugfix, before writing implementation code"
|
|
---
|
|
|
|
{/* This page is auto-generated from the skill's SKILL.md by website/scripts/generate-skill-docs.py. Edit the source SKILL.md, not this page. */}
|
|
|
|
# Test Driven Development
|
|
|
|
Use when implementing any feature or bugfix, before writing implementation code. Enforces RED-GREEN-REFACTOR cycle with test-first approach.
|
|
|
|
## Skill metadata
|
|
|
|
| | |
|
|
|---|---|
|
|
| Source | Bundled (installed by default) |
|
|
| Path | `skills/software-development/test-driven-development` |
|
|
| Version | `1.1.0` |
|
|
| Author | Hermes Agent (adapted from obra/superpowers) |
|
|
| License | MIT |
|
|
| Tags | `testing`, `tdd`, `development`, `quality`, `red-green-refactor` |
|
|
| Related skills | [`systematic-debugging`](/docs/user-guide/skills/bundled/software-development/software-development-systematic-debugging), [`writing-plans`](/docs/user-guide/skills/bundled/software-development/software-development-writing-plans), [`subagent-driven-development`](/docs/user-guide/skills/bundled/software-development/software-development-subagent-driven-development) |
|
|
|
|
## Reference: full SKILL.md
|
|
|
|
:::info
|
|
The following is the complete skill definition that Hermes loads when this skill is triggered. This is what the agent sees as instructions when the skill is active.
|
|
:::
|
|
|
|
# Test-Driven Development (TDD)
|
|
|
|
## Overview
|
|
|
|
Write the test first. Watch it fail. Write minimal code to pass.
|
|
|
|
**Core principle:** If you didn't watch the test fail, you don't know if it tests the right thing.
|
|
|
|
**Violating the letter of the rules is violating the spirit of the rules.**
|
|
|
|
## When to Use
|
|
|
|
**Always:**
|
|
- New features
|
|
- Bug fixes
|
|
- Refactoring
|
|
- Behavior changes
|
|
|
|
**Exceptions (ask the user first):**
|
|
- Throwaway prototypes
|
|
- Generated code
|
|
- Configuration files
|
|
|
|
Thinking "skip TDD just this once"? Stop. That's rationalization.
|
|
|
|
## The Iron Law
|
|
|
|
```
|
|
NO PRODUCTION CODE WITHOUT A FAILING TEST FIRST
|
|
```
|
|
|
|
Write code before the test? Delete it. Start over.
|
|
|
|
**No exceptions:**
|
|
- Don't keep it as "reference"
|
|
- Don't "adapt" it while writing tests
|
|
- Don't look at it
|
|
- Delete means delete
|
|
|
|
Implement fresh from tests. Period.
|
|
|
|
## Red-Green-Refactor Cycle
|
|
|
|
### RED — Write Failing Test
|
|
|
|
Write one minimal test showing what should happen.
|
|
|
|
**Good test:**
|
|
```python
|
|
def test_retries_failed_operations_3_times():
|
|
attempts = 0
|
|
def operation():
|
|
nonlocal attempts
|
|
attempts += 1
|
|
if attempts < 3:
|
|
raise Exception('fail')
|
|
return 'success'
|
|
|
|
result = retry_operation(operation)
|
|
|
|
assert result == 'success'
|
|
assert attempts == 3
|
|
```
|
|
Clear name, tests real behavior, one thing.
|
|
|
|
**Bad test:**
|
|
```python
|
|
def test_retry_works():
|
|
mock = MagicMock()
|
|
mock.side_effect = [Exception(), Exception(), 'success']
|
|
result = retry_operation(mock)
|
|
assert result == 'success' # What about retry count? Timing?
|
|
```
|
|
Vague name, tests mock not real code.
|
|
|
|
**Requirements:**
|
|
- One behavior per test
|
|
- Clear descriptive name ("and" in name? Split it)
|
|
- Real code, not mocks (unless truly unavoidable)
|
|
- Name describes behavior, not implementation
|
|
|
|
### Verify RED — Watch It Fail
|
|
|
|
**MANDATORY. Never skip.**
|
|
|
|
```bash
|
|
# Use terminal tool to run the specific test
|
|
pytest tests/test_feature.py::test_specific_behavior -v
|
|
```
|
|
|
|
Confirm:
|
|
- Test fails (not errors from typos)
|
|
- Failure message is expected
|
|
- Fails because the feature is missing
|
|
|
|
**Test passes immediately?** You're testing existing behavior. Fix the test.
|
|
|
|
**Test errors?** Fix the error, re-run until it fails correctly.
|
|
|
|
### GREEN — Minimal Code
|
|
|
|
Write the simplest code to pass the test. Nothing more.
|
|
|
|
**Good:**
|
|
```python
|
|
def add(a, b):
|
|
return a + b # Nothing extra
|
|
```
|
|
|
|
**Bad:**
|
|
```python
|
|
def add(a, b):
|
|
result = a + b
|
|
logging.info(f"Adding {a} + {b} = {result}") # Extra!
|
|
return result
|
|
```
|
|
|
|
Don't add features, refactor other code, or "improve" beyond the test.
|
|
|
|
**Cheating is OK in GREEN:**
|
|
- Hardcode return values
|
|
- Copy-paste
|
|
- Duplicate code
|
|
- Skip edge cases
|
|
|
|
We'll fix it in REFACTOR.
|
|
|
|
### Verify GREEN — Watch It Pass
|
|
|
|
**MANDATORY.**
|
|
|
|
```bash
|
|
# Run the specific test
|
|
pytest tests/test_feature.py::test_specific_behavior -v
|
|
|
|
# Then run ALL tests to check for regressions
|
|
pytest tests/ -q
|
|
```
|
|
|
|
Confirm:
|
|
- Test passes
|
|
- Other tests still pass
|
|
- Output pristine (no errors, warnings)
|
|
|
|
**Test fails?** Fix the code, not the test.
|
|
|
|
**Other tests fail?** Fix regressions now.
|
|
|
|
### REFACTOR — Clean Up
|
|
|
|
After green only:
|
|
- Remove duplication
|
|
- Improve names
|
|
- Extract helpers
|
|
- Simplify expressions
|
|
|
|
Keep tests green throughout. Don't add behavior.
|
|
|
|
**If tests fail during refactor:** Undo immediately. Take smaller steps.
|
|
|
|
### Repeat
|
|
|
|
Next failing test for next behavior. One cycle at a time.
|
|
|
|
## Why Order Matters
|
|
|
|
**"I'll write tests after to verify it works"**
|
|
|
|
Tests written after code pass immediately. Passing immediately proves nothing:
|
|
- Might test the wrong thing
|
|
- Might test implementation, not behavior
|
|
- Might miss edge cases you forgot
|
|
- You never saw it catch the bug
|
|
|
|
Test-first forces you to see the test fail, proving it actually tests something.
|
|
|
|
**"I already manually tested all the edge cases"**
|
|
|
|
Manual testing is ad-hoc. You think you tested everything but:
|
|
- No record of what you tested
|
|
- Can't re-run when code changes
|
|
- Easy to forget cases under pressure
|
|
- "It worked when I tried it" ≠ comprehensive
|
|
|
|
Automated tests are systematic. They run the same way every time.
|
|
|
|
**"Deleting X hours of work is wasteful"**
|
|
|
|
Sunk cost fallacy. The time is already gone. Your choice now:
|
|
- Delete and rewrite with TDD (high confidence)
|
|
- Keep it and add tests after (low confidence, likely bugs)
|
|
|
|
The "waste" is keeping code you can't trust.
|
|
|
|
**"TDD is dogmatic, being pragmatic means adapting"**
|
|
|
|
TDD IS pragmatic:
|
|
- Finds bugs before commit (faster than debugging after)
|
|
- Prevents regressions (tests catch breaks immediately)
|
|
- Documents behavior (tests show how to use code)
|
|
- Enables refactoring (change freely, tests catch breaks)
|
|
|
|
"Pragmatic" shortcuts = debugging in production = slower.
|
|
|
|
**"Tests after achieve the same goals — it's spirit not ritual"**
|
|
|
|
No. Tests-after answer "What does this do?" Tests-first answer "What should this do?"
|
|
|
|
Tests-after are biased by your implementation. You test what you built, not what's required. Tests-first force edge case discovery before implementing.
|
|
|
|
## Common Rationalizations
|
|
|
|
| Excuse | Reality |
|
|
|--------|---------|
|
|
| "Too simple to test" | Simple code breaks. Test takes 30 seconds. |
|
|
| "I'll test after" | Tests passing immediately prove nothing. |
|
|
| "Tests after achieve same goals" | Tests-after = "what does this do?" Tests-first = "what should this do?" |
|
|
| "Already manually tested" | Ad-hoc ≠ systematic. No record, can't re-run. |
|
|
| "Deleting X hours is wasteful" | Sunk cost fallacy. Keeping unverified code is technical debt. |
|
|
| "Keep as reference, write tests first" | You'll adapt it. That's testing after. Delete means delete. |
|
|
| "Need to explore first" | Fine. Throw away exploration, start with TDD. |
|
|
| "Test hard = design unclear" | Listen to the test. Hard to test = hard to use. |
|
|
| "TDD will slow me down" | TDD faster than debugging. Pragmatic = test-first. |
|
|
| "Manual test faster" | Manual doesn't prove edge cases. You'll re-test every change. |
|
|
| "Existing code has no tests" | You're improving it. Add tests for the code you touch. |
|
|
|
|
## Red Flags — STOP and Start Over
|
|
|
|
If you catch yourself doing any of these, delete the code and restart with TDD:
|
|
|
|
- Code before test
|
|
- Test after implementation
|
|
- Test passes immediately on first run
|
|
- Can't explain why test failed
|
|
- Tests added "later"
|
|
- Rationalizing "just this once"
|
|
- "I already manually tested it"
|
|
- "Tests after achieve the same purpose"
|
|
- "Keep as reference" or "adapt existing code"
|
|
- "Already spent X hours, deleting is wasteful"
|
|
- "TDD is dogmatic, I'm being pragmatic"
|
|
- "This is different because..."
|
|
|
|
**All of these mean: Delete code. Start over with TDD.**
|
|
|
|
## Verification Checklist
|
|
|
|
Before marking work complete:
|
|
|
|
- [ ] Every new function/method has a test
|
|
- [ ] Watched each test fail before implementing
|
|
- [ ] Each test failed for expected reason (feature missing, not typo)
|
|
- [ ] Wrote minimal code to pass each test
|
|
- [ ] All tests pass
|
|
- [ ] Output pristine (no errors, warnings)
|
|
- [ ] Tests use real code (mocks only if unavoidable)
|
|
- [ ] Edge cases and errors covered
|
|
|
|
Can't check all boxes? You skipped TDD. Start over.
|
|
|
|
## When Stuck
|
|
|
|
| Problem | Solution |
|
|
|---------|----------|
|
|
| Don't know how to test | Write the wished-for API. Write the assertion first. Ask the user. |
|
|
| Test too complicated | Design too complicated. Simplify the interface. |
|
|
| Must mock everything | Code too coupled. Use dependency injection. |
|
|
| Test setup huge | Extract helpers. Still complex? Simplify the design. |
|
|
|
|
## Hermes Agent Integration
|
|
|
|
### Running Tests
|
|
|
|
Use the `terminal` tool to run tests at each step:
|
|
|
|
```python
|
|
# RED — verify failure
|
|
terminal("pytest tests/test_feature.py::test_name -v")
|
|
|
|
# GREEN — verify pass
|
|
terminal("pytest tests/test_feature.py::test_name -v")
|
|
|
|
# Full suite — verify no regressions
|
|
terminal("pytest tests/ -q")
|
|
```
|
|
|
|
### With delegate_task
|
|
|
|
When dispatching subagents for implementation, enforce TDD in the goal:
|
|
|
|
```python
|
|
delegate_task(
|
|
goal="Implement [feature] using strict TDD",
|
|
context="""
|
|
Follow test-driven-development skill:
|
|
1. Write failing test FIRST
|
|
2. Run test to verify it fails
|
|
3. Write minimal code to pass
|
|
4. Run test to verify it passes
|
|
5. Refactor if needed
|
|
6. Commit
|
|
|
|
Project test command: pytest tests/ -q
|
|
Project structure: [describe relevant files]
|
|
""",
|
|
toolsets=['terminal', 'file']
|
|
)
|
|
```
|
|
|
|
### With systematic-debugging
|
|
|
|
Bug found? Write failing test reproducing it. Follow TDD cycle. The test proves the fix and prevents regression.
|
|
|
|
Never fix bugs without a test.
|
|
|
|
## Testing Anti-Patterns
|
|
|
|
- **Testing mock behavior instead of real behavior** — mocks should verify interactions, not replace the system under test
|
|
- **Testing implementation details** — test behavior/results, not internal method calls
|
|
- **Happy path only** — always test edge cases, errors, and boundaries
|
|
- **Brittle tests** — tests should verify behavior, not structure; refactoring shouldn't break them
|
|
|
|
## Final Rule
|
|
|
|
```
|
|
Production code → test exists and failed first
|
|
Otherwise → not TDD
|
|
```
|
|
|
|
No exceptions without the user's explicit permission.
|