Skip to main content

expectations

Working expectations and documentation practices. Use when capturing learnings, documenting gotchas, recording architectural decisions, or understanding how to work with a codebase. Triggers on "document this", "remember this pattern", "what should I know about", or after completing significant features. Use when this capability is needed.

Jump to install

Source facts

Repository
tomevault-io/tomes
Last source activity
July 23, 2026 at 21:48
Detected SKILL.md language
English
Stars
1
Forks
0

Install options

The review-first prompt is selected by default. You can switch to a direct command or download a local copy.

Review the source files

Read SKILL.md and any companion files shown by SkillsMP before deciding whether to install.

Showing SKILL.md

SKILL.md
Source instructions · Read-only preview
name
expectations
description
Working expectations and documentation practices. Use when capturing learnings, documenting gotchas, recording architectural decisions, or understanding how to work with a codebase. Triggers on "document this", "remember this pattern", "what should I know about", or after completing significant features. Use when this capability is needed.
metadata
{"author":"citypaul"}
# Expectations ## When Working with Code 1. **ALWAYS FOLLOW TDD** - No production code without a failing test. Non-negotiable. 2. **Think deeply** before making any edits 3. **Understand the full context** of the code and requirements 4. **Ask clarifying questions** when requirements are ambiguous 5. **Think from first principles** - don't make assumptions 6. **Assess refactoring after mutation testing confirms test strength** - but only refactor if it adds value 7. **Keep project docs current** - Update CLAUDE.md when introducing meaningful changes ## Documentation Framework **At the end of every significant change, ask: "What do I wish I'd known at the start?"** Document if ANY of these are true: - Would save future developers significant time - Prevents a class of bugs or errors - Reveals non-obvious behavior or constraints - Captures architectural rationale or trade-offs - Documents domain-specific knowledge - Identifies effective patterns or anti-patterns - Clarifies tool setup or configuration gotchas ## Types of Learnings to Capture - **Gotchas**: Unexpected behavior discovered (e.g., "API returns null instead of empty array") - **Patterns**: Approaches that worked particularly well - **Anti-patterns**: Approaches that seemed good but caused problems - **Decisions**: Architectural choices with rationale and trade-offs - **Edge cases**: Non-obvious scenarios that required special handling - **Tool knowledge**: Setup, configuration, or usage insights ## Documentation Format ```markdown #### Gotcha: [Descriptive Title] **Context**: When this occurs **Issue**: What goes wrong **Solution**: How to handle it // CORRECT - Solution const example = "correct approach"; // WRONG - What causes the problem const wrong = "incorrect approach"; ``` ## Code Change Principles - **Start with a failing test** - always. No exceptions. - After making tests pass, always assess refactoring opportunities - After refactoring, verify all tests and static analysis pass, then commit - Respect the existing patterns and conventions - Maintain test coverage for all behavior changes - Keep changes small and incremental - Ensure all TypeScript strict mode requirements are met - Provide rationale for significant design decisions **If you find yourself writing production code without a failing test, STOP immediately and write the test first.** ## Communication - Be explicit about trade-offs in different approaches - Explain the reasoning behind significant design decisions - Flag any deviations from guidelines with justification - Suggest improvements that align with these principles - When unsure, ask for clarification rather than assuming --- > Converted and distributed by [TomeVault](https://tomevault.io/claim/citypaul) — claim your Tome and manage your conversions. <!-- tomevault:4.0:skill_md:2026-04-11 -->
View on GitHub