f4ba64fe6a
Includes: - Spec-driven development workflow - Type safety requirements (Python/TypeScript) - Tool usage guidelines (Ref, Exa, code review) - MCP configuration and disabling guide - Background agent patterns with spec context - Homelab infrastructure reference - Pre-commit checklist - Error recovery patterns - Permission boundaries Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
71 lines
1.8 KiB
Markdown
71 lines
1.8 KiB
Markdown
# Project Template
|
|
|
|
Template repository for new projects with Claude Code integration.
|
|
|
|
## Quick Start
|
|
|
|
1. Clone this template:
|
|
```bash
|
|
git clone git@git.htsn.io:hutson/template-project.git my-new-project
|
|
cd my-new-project
|
|
rm -rf .git && git init
|
|
```
|
|
|
|
2. Customize `CLAUDE.md`:
|
|
- Update `[PROJECT_NAME]` with your project name
|
|
- Fill in `[CUSTOMIZE]` sections
|
|
- Remove template instructions blockquote
|
|
|
|
3. Start development with spec-kit:
|
|
```bash
|
|
/speckit.specify # Define requirements
|
|
/speckit.plan # Plan implementation
|
|
/speckit.tasks # Break into tasks
|
|
/speckit.implement # Build it
|
|
```
|
|
|
|
## What's Included
|
|
|
|
- `CLAUDE.md` - Comprehensive Claude Code configuration with:
|
|
- Spec-driven development workflow
|
|
- Type safety requirements (Python/TypeScript)
|
|
- Tool usage guidelines (Ref, Exa, code review, etc.)
|
|
- MCP configuration
|
|
- Background agent patterns
|
|
- Homelab infrastructure reference
|
|
- Pre-commit checklist
|
|
- Error recovery patterns
|
|
|
|
## Directory Structure
|
|
|
|
```
|
|
.
|
|
├── CLAUDE.md # Claude Code instructions
|
|
├── README.md # This file
|
|
├── src/ # Source code (create as needed)
|
|
├── tests/ # Test files (create as needed)
|
|
├── docs/ # Documentation (create as needed)
|
|
└── specs/ # Spec-kit specifications (if using)
|
|
```
|
|
|
|
## Workflow
|
|
|
|
### New Feature
|
|
```
|
|
/speckit.specify → /speckit.plan → /speckit.tasks → /speckit.implement
|
|
/code-review:code-review
|
|
/commit-commands:commit
|
|
```
|
|
|
|
### Bug Fix
|
|
```
|
|
# Direct implementation, then:
|
|
/code-review:code-review
|
|
/commit-commands:commit
|
|
```
|
|
|
|
## Related
|
|
|
|
- [Homelab Documentation](https://git.htsn.io/hutson/homelab)
|
|
- [Claude Code Best Practices](https://www.anthropic.com/engineering/claude-code-best-practices)
|