Contributing to torrentclaw-mcp

Thanks for your interest in contributing! Here's how you can help.

Getting Started

Fork the repository
Clone your fork: git clone https://github.com/<your-user>/torrentclaw-mcp.git
Install dev tools and git hooks:
```
make install-tools
make hooks
```
Create a branch: git checkout -b feat/my-feature
Make your changes
Test locally: make build && make test
Commit with a clear message (see below) — the commit-msg hook will validate the format
Push and open a Pull Request

Requirements

Node.js 18+
npm
lefthook (installed via make install-tools)

Commit Messages

Commits are validated automatically by a git hook. We follow Conventional Commits:

<type>[optional scope][!]: <description>

Valid types: feat, fix, docs, style, refactor, perf, test, build, ci, chore, revert

Examples:

feat: add new audio codec detection
fix(scanner): correct HDR10 detection for MKV files
docs: update README examples
refactor: simplify piece selection logic
feat!: redesign output format

Code Style

Run npx prettier --write . before committing (or make fmt)
TypeScript strict mode is enabled
Keep functions focused and small
Add comments only where the logic isn't self-evident

Reporting Bugs

Open an issue with:

What you expected to happen
What actually happened
Steps to reproduce
Your Node.js version and OS

License

By contributing, you agree that your contributions will be licensed under the project's MIT License.

1.6 KiB Raw Blame History