Welcome to the kidd contributing docs. This directory contains standards, templates, and guides for working in this codebase.
- Standards define the rules -- read the relevant standard before writing code or docs.
- Concepts explain the "what" and "why" behind key architectural decisions.
- Guides are step-by-step walkthroughs for common tasks.
- Naming -- File, variable, and property naming conventions
- Functions -- Object parameters, JSDoc, pure functions
- Design Patterns -- Functional patterns, factories, composition
- Coding Style -- Formatting, naming conventions, code organization
- State -- Immutability, state encapsulation, data flow
- Conditionals -- ts-pattern, branching logic
- Types -- Discriminated unions, branded types, type patterns
- Errors -- Result type, error handling
- Utilities -- es-toolkit reference
- Testing -- Test structure, mocking, coverage
- Commits -- Commit message format and conventions
- Pull Requests -- PR creation, review, and merge process
- Writing -- Writing standards and templates
- Formatting -- Code examples, tables, markdown
- Diagrams -- Mermaid diagram standards
- Architecture -- Package ecosystem, system layers, context, data flow
- CLI -- Commands, middleware, context, autoloading, error flow
- Getting Started -- Local setup, reading order, Claude Code configuration
- Developing a Feature -- Branch, code, test, changeset, PR, merge
- Adding a CLI Command -- End-to-end walkthrough for new commands