Clean Code
Principles, practices, and workflows for TypeScript developers.
Quick Start For a task: Check guidelines.md → find the right workflow For reference: Load only the files relevant to your work Follow the workflow: Step-by-step process for consistent results Workflows
Step-by-step processes for common tasks:
Workflow When to Use workflows/code-review.md Reviewing code for quality workflows/pr-review.md Reviewing pull requests workflows/tdd.md Test-driven development cycle workflows/refactoring.md Safe refactoring with tests workflows/new-feature.md Building new functionality workflows/bug-fix.md Fixing bugs properly workflows/test-strategy.md Planning test coverage workflows/estimation.md Estimating tasks (PERT) workflows/deadline-negotiation.md Handling unrealistic deadlines Reference Categories Part 1: Code Quality (Clean Code book) Category Files Purpose naming 3 Variable, function, class naming functions 4 Function design and review classes 3 Class/module design comments 3 Comment best practices error-handling 3 Exception handling unit-tests 3 Clean test principles formatting 3 Code layout smells 3 Code smell catalog (50+) Part 2: Professional Practices (Clean Coder book) Category Files Purpose professionalism 3 Professional ethics saying-no 3 Declining requests commitment 3 Making promises coding-practices 3 Daily habits, flow, debugging tdd 3 TDD workflow and benefits practicing 3 Deliberate practice acceptance-testing 3 Requirements as tests testing-strategies 3 Test pyramid time-management 3 Meetings, focus estimation 3 PERT estimation pressure 3 Working under pressure collaboration 3 Working with teams Key Principles Code Quality Readability - Code is read far more than written Single Responsibility - Each unit does one thing well Small Units - Functions ~5-20 lines, focused classes Meaningful Names - Names reveal intent DRY - Don't Repeat Yourself Clean Tests - Tests are first-class citizens Professional Practices Take Responsibility - Own your code and decisions Say No - Decline impossible commitments professionally Commit Clearly - Use "I will... by..." language Estimates != Commitments - Communicate uncertainty Stay Clean Under Pressure - Don't abandon practices in crisis Guidelines
See guidelines.md for:
Task → workflow mapping Situation → reference file mapping Decision tree for common scenarios