mirror of
https://github.com/digitalsamba/claude-code-video-toolkit.git
synced 2026-09-18 19:41:13 +08:00
17d56fbfe9
- Add missing /versions command to README.md Commands table - Add Documentation Checklist to CONTRIBUTING.md for keeping docs in sync - Cross-reference checklist from docs/contributing.md 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
3.9 KiB
3.9 KiB
Contributing to claude-code-video-toolkit
This toolkit is designed to grow through use. Every interaction is an opportunity to improve.
How to Contribute
Local Users (working with Claude Code)
- Tell Claude - Just say "I have feedback" or "this could be better"
- Claude captures it - Ideas go to
_internal/BACKLOG.md, bugs get fixed - Patterns emerge - Common needs become new features
- Submit upstream -
gh pr createto share with others
Remote Contributors (via GitHub)
- Issues: github.com/digitalsamba/claude-code-video-toolkit/issues
- Bug reports, feature requests, questions
- Pull Requests: Fork, improve, submit PR
- New templates, skills, commands
- Documentation improvements
- Bug fixes
Evolution Principles
Commands Evolve
Commands start simple and grow based on real usage:
/videostarted as/new-sprint-video, expanded to multi-template, multi-session/brandmerged creation and listing into one entry point- Patterns that work get documented; patterns that don't get removed
Skills Mature
Skills progress through maturity levels:
- draft → beta → stable
- Each real-world use validates or improves the skill
- Reference docs grow from actual questions and edge cases
Templates Generalize
Templates extract patterns from projects:
- Build a project, notice reusable patterns
- Extract to template, parameterize the specifics
- Share components via
lib/when used across templates
The Toolkit Learns
Every session teaches the toolkit something:
- What workflows are awkward? → Improve commands
- What questions keep coming up? → Add to skill docs
- What's missing? → Add to
_internal/BACKLOG.md
Feedback Categories
| Category | Action |
|---|---|
| Bugs | Fix immediately or document in BACKLOG.md |
| Ideas | Capture in BACKLOG.md under appropriate section |
| Documentation | Update relevant skill, command, or docs/ |
| Workflow | Update commands or CLAUDE.md |
| Templates | Add to BACKLOG.md → Templates section |
Important: When adding commands, skills, or templates, follow the Documentation Checklist to ensure all docs stay in sync.
Quick Contribution (from your working copy)
# 1. Check what you're about to share (projects/ won't appear)
git status
# 2. Create a branch for your improvement
git checkout -b improve/description
# 3. Stage only toolkit files (projects/ is ignored automatically)
git add .claude/ templates/ lib/ docs/ _internal/
# 4. Commit
git commit -m "Improve: description"
# 5. Create PR
gh pr create --title "Improve: description" --body "..."
Clean Contribution (fresh clone)
If you want to be extra careful:
# Clone fresh
git clone https://github.com/digitalsamba/claude-code-video-toolkit ~/toolkit-contrib
cd ~/toolkit-contrib
# Copy only the files you improved
cp -r /path/to/your/work/.claude/commands/improved-command.md .claude/commands/
# Commit and PR
git checkout -b improve/description
git add -A
git commit -m "Improve: description"
gh pr create
What's Safe to Share
| Directory | Shared? | Contains |
|---|---|---|
.claude/commands/ |
Yes | Slash commands |
.claude/skills/ |
Yes | Skill documentation |
templates/ |
Yes | Video templates |
lib/ |
Yes | Shared components |
docs/ |
Yes | Documentation |
tools/ |
Yes | Python CLI tools |
brands/ |
Careful | Only share generic brands |
projects/ |
No | Your private video work |
assets/voices/ |
No | Your voice samples |
Toolkit Tracking Files
| File | Purpose |
|---|---|
_internal/ROADMAP.md |
What we're building (phases, current work) |
_internal/BACKLOG.md |
What we might build (unscheduled ideas) |
_internal/CHANGELOG.md |
What we built (historical record) |