mirror of
https://github.com/affaan-m/everything-claude-code.git
synced 2026-03-30 21:53:28 +08:00
da74f85c10
- Add missing code-review.md and development-workflow.md to zh/README.md directory listing - Add mkdir -p command before copy in manual install instructions - Fix TypeScript test command path in SKILL-DEVELOPMENT-GUIDE.md - Add Anti-Patterns section to SKILL.md template - Add Template category to Skill Categories table in CONTRIBUTING.md - Add Pre-Review Requirements section to code-review.md (both en and zh) - Add Pre-Review Checks step to development-workflow.md (both en and zh) - Add trailing newlines to all files that were missing them
45 lines
2.2 KiB
Markdown
45 lines
2.2 KiB
Markdown
# Development Workflow
|
|
|
|
> This file extends [common/git-workflow.md](./git-workflow.md) with the full feature development process that happens before git operations.
|
|
|
|
The Feature Implementation Workflow describes the development pipeline: research, planning, TDD, code review, and then committing to git.
|
|
|
|
## Feature Implementation Workflow
|
|
|
|
0. **Research & Reuse** _(mandatory before any new implementation)_
|
|
- **GitHub code search first:** Run `gh search repos` and `gh search code` to find existing implementations, templates, and patterns before writing anything new.
|
|
- **Library docs second:** Use Context7 or primary vendor docs to confirm API behavior, package usage, and version-specific details before implementing.
|
|
- **Exa only when the first two are insufficient:** Use Exa for broader web research or discovery after GitHub search and primary docs.
|
|
- **Check package registries:** Search npm, PyPI, crates.io, and other registries before writing utility code. Prefer battle-tested libraries over hand-rolled solutions.
|
|
- **Search for adaptable implementations:** Look for open-source projects that solve 80%+ of the problem and can be forked, ported, or wrapped.
|
|
- Prefer adopting or porting a proven approach over writing net-new code when it meets the requirement.
|
|
|
|
1. **Plan First**
|
|
- Use **planner** agent to create implementation plan
|
|
- Generate planning docs before coding: PRD, architecture, system_design, tech_doc, task_list
|
|
- Identify dependencies and risks
|
|
- Break down into phases
|
|
|
|
2. **TDD Approach**
|
|
- Use **tdd-guide** agent
|
|
- Write tests first (RED)
|
|
- Implement to pass tests (GREEN)
|
|
- Refactor (IMPROVE)
|
|
- Verify 80%+ coverage
|
|
|
|
3. **Code Review**
|
|
- Use **code-reviewer** agent immediately after writing code
|
|
- Address CRITICAL and HIGH issues
|
|
- Fix MEDIUM issues when possible
|
|
|
|
4. **Commit & Push**
|
|
- Detailed commit messages
|
|
- Follow conventional commits format
|
|
- See [git-workflow.md](./git-workflow.md) for commit message format and PR process
|
|
|
|
5. **Pre-Review Checks**
|
|
- Verify all automated checks (CI/CD) are passing
|
|
- Resolve any merge conflicts
|
|
- Ensure branch is up to date with target branch
|
|
- Only request review after these checks pass
|