Skip to content

Contributing to TaskRepo

Thank you for your interest in contributing to TaskRepo!

Ways to Contribute

  • Report bugs
  • Suggest features
  • Improve documentation
  • Submit pull requests

Getting Started

  1. Fork the repository
  2. Clone your fork
  3. Create a feature branch
  4. Make your changes
  5. Run tests
  6. Submit a pull request

Development Setup

git clone https://github.com/YOUR_USERNAME/TaskRepo
cd TaskRepo

# Install with dev dependencies
uv sync --extra dev

# Install pre-commit hooks
uv run pre-commit install

Running Tests

# All tests
uv run pytest tests/ -v

# With coverage
uv run pytest tests/ -v --cov=taskrepo

Code Quality

# Format
uv run ruff format .

# Lint
uv run ruff check .

# Type check
uv run mypy src/taskrepo

Pull Request Process

  1. Update documentation for new features
  2. Add tests for bug fixes and new features
  3. Ensure all tests pass
  4. Update CHANGELOG.md
  5. Submit PR with clear description

Questions?

Ask in GitHub Discussions