An AI-powered task-management system you can drop into Cursor, Lovable, Windsurf, Roo, and others.
JavaScript aicursorcursor-aicursorailovablelovable-devroocodetask-managertaskstasks-listwindsurfwindsurf-ai
chore: add contributing.md (#611)
Ralph Khreishacd5c1ea3d22
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.mdnew file mode 100644index 00000000..7ca91698--- /dev/null+++ b/CONTRIBUTING.md@@ -0,0 +1,335 @@+# Contributing to Task Master++Thank you for your interest in contributing to Task Master! We're excited to work with you and appreciate your help in making this project better. π++## π€ Our Collaborative Approach++We're a **PR-friendly team** that values collaboration:++- β **We review PRs quickly** - Usually within hours, not days+- β **We're super reactive** - Expect fast feedback and engagement+- β **We sometimes take over PRs** - If your contribution is valuable but needs cleanup, we might jump in to help finish it+- β **We're open to all contributions** - From bug fixes to major features++**We don't mind AI-generated code**, but we do expect you to:++- β **Review and understand** what the AI generated+- β **Test the code thoroughly** before submitting+- β **Ensure it's well-written** and follows our patterns+- β **Don't submit "AI slop"** - untested, unreviewed AI output++> **Why this matters**: We spend significant time reviewing PRs. Help us help you by submitting quality contributions that save everyone time!++## π Quick Start for Contributors++### 1. Fork and Clone++```bash+git clone https://github.com/YOUR_USERNAME/claude-task-master.git+cd claude-task-master+npm install+```++### 2. Create a Feature Branch++**Important**: Always target the `next` branch, not `main`:++```bash+git checkout next+git pull origin next+git checkout -b feature/your-feature-name+```++### 3. Make Your Changes++Follow our development guidelines below.++### 4. Test Everything Yourself++**Before submitting your PR**, ensure:++```bash+# Run all tests+npm test++# Check formatting+npm run format-check++# Fix formatting if needed+npm run format+```++### 5. Create a Changeset++**Required for most changes**:++```bash+npm run changeset+```++See the [Changeset Guidelines](#changeset-guidelines) below for details.++### 6. Submit Your PR++- Target the `next` branch+- Write a clear description+- Reference any related issues++## π Development Guidelines++### Branch Strategy++- **`main`**: Production-ready code+- **`next`**: Development branch - **target this for PRs**+- **Feature branches**: `feature/description` or `fix/description`++### Code Quality Standards++1. **Write tests** for new functionality+2. **Follow existing patterns** in the codebase+3. **Add JSDoc comments** for functions+4. **Keep functions focused** and single-purpose++### Testing Requirements++Your PR **must pass all CI checks**:++- β **Unit tests**: `npm test`+- β **Format check**: `npm run format-check`++**Test your changes locally first** - this saves review time and shows you care about quality.++## π¦ Changeset Guidelines++We use [Changesets](https://github.com/changesets/changesets) to manage versioning and generate changelogs.++### When to Create a Changeset++**Always create a changeset for**:++- β New features+- β Bug fixes+- β Breaking changes+- β Performance improvements+- β User-facing documentation updates+- β Dependency updates that affect functionality++**Skip changesets for**:++- β Internal documentation only+- β Test-only changes+- β Code formatting/linting+- β Development tooling that doesn't affect users++### How to Create a Changeset++1. **After making your changes**:++ ```bash+ npm run changeset+ ```++2. **Choose the bump type**:++ - **Major**: Breaking changes+ - **Minor**: New features+ - **Patch**: Bug fixes, docs, performance improvements++3. **Write a clear summary**:++ ```+ Add support for custom AI models in MCP configuration+ ```++4. **Commit the changeset file** with your changes:+ ```bash+ git add .changeset/*.md+ git commit -m "feat: add custom AI model support"+ ```++### Changeset vs Git Commit Messages++- **Changeset summary**: User-facing, goes in CHANGELOG.md+- **Git commit**: Developer-facing, explains the technical change++Example:++```bash+# Changeset summary (user-facing)+"Add support for custom Ollama models"++# Git commit message (developer-facing)+"feat(models): implement custom Ollama model validation++- Add model validation for custom Ollama endpoints+- Update configuration schema to support custom models+- Add tests for new validation logic"+```++## π§ Development Setup++### Prerequisites++- Node.js 14++- npm or yarn++### Environment Setup++1. **Copy environment template**:++ ```bash+ cp .env.example .env+ ```++2. **Add your API keys** (for testing AI features):+ ```bash+ ANTHROPIC_API_KEY=your_key_here+ OPENAI_API_KEY=your_key_here+ # Add others as needed+ ```++### Running Tests++```bash+# Run all tests+npm test++# Run tests in watch mode+npm run test:watch++# Run with coverage+npm run test:coverage++# Run E2E tests+npm run test:e2e+```++### Code Formatting++We use Prettier for consistent formatting:++```bash+# Check formatting+npm run format-check++# Fix formatting+npm run format+```++## π PR Guidelines++### Before Submitting++- [ ] **Target the `next` branch**+- [ ] **Test everything locally**+- [ ] **Run the full test suite**+- [ ] **Check code formatting**+- [ ] **Create a changeset** (if needed)+- [ ] **Re-read your changes** - ensure they're clean and well-thought-out++### PR Description Template++```markdown+## Description++Brief description of what this PR does.++## Type of Change++- [ ] Bug fix+- [ ] New feature+- [ ] Breaking change+- [ ] Documentation update++## Testing++- [ ] I have tested this locally+- [ ] All existing tests pass+- [ ] I have added tests for new functionality++## Changeset++- [ ] I have created a changeset (or this change doesn't need one)++## Additional Notes++Any additional context or notes for reviewers.+```++### What We Look For++β **Good PRs**:++- Clear, focused changes+- Comprehensive testing+- Good commit messages+- Proper changeset (when needed)+- Self-reviewed code++β **Avoid**:++- Massive PRs that change everything+- Untested code+- Formatting issues+- Missing changesets for user-facing changes+- AI-generated code that wasn't reviewed++## ποΈ Project Structure++```+claude-task-master/+βββ bin/ # CLI executables+βββ mcp-server/ # MCP server implementation+βββ scripts/ # Core task management logic+βββ src/ # Shared utilities and providers and well refactored code (we are slowly moving everything here)+βββ tests/ # Test files+βββ docs/ # Documentation+βββ .cursor/ # Cursor IDE rules and configuration+βββ assets/ # Assets like rules and configuration for all IDEs+```++### Key Areas for Contribution++- **CLI Commands**: `scripts/modules/commands.js`+- **MCP Tools**: `mcp-server/src/tools/`+- **Core Logic**: `scripts/modules/task-manager/`+- **AI Providers**: `src/ai-providers/`+- **Tests**: `tests/`++## π Reporting Issues++### Bug Reports++Include:++- Task Master version+- Node.js version+- Operating system+- Steps to reproduce+- Expected vs actual behavior+- Error messages/logs++### Feature Requests++Include:++- Clear description of the feature+- Use case/motivation+- Proposed implementation (if you have ideas)+- Willingness to contribute++## π¬ Getting Help++- **Discord**: [Join our community](https://discord.gg/taskmasterai)+- **Issues**: [GitHub Issues](https://github.com/eyaltoledano/claude-task-master/issues)+- **Discussions**: [GitHub Discussions](https://github.com/eyaltoledano/claude-task-master/discussions)++## π License++By contributing, you agree that your contributions will be licensed under the same license as the project (MIT with Commons Clause).++---++**Thank you for contributing to Task Master!** π++Your contributions help make AI-driven development more accessible and efficient for everyone.