Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
71 lines (46 loc) · 1.89 KB

CONTRIBUTING.md

File metadata and controls

71 lines (46 loc) · 1.89 KB

Contributing to hanagram

Thank you for your interest in contributing! There are many ways to help improve this project.

Ways to Contribute

🐛 Report Issues

Found a bug or have a feature request? Open an issue on GitHub.

💬 Join Discussions

Have questions or ideas? Join the conversation in GitHub Discussions.

🔧 Code Contributions

We welcome pull requests!

If you're new to contributing to open source, check out How to Contribute to Open Source.

Ready to get started? Follow the development setup below.

Development Setup

Prerequisites

  • Install git and uv
  • Optional: install just to use just instead of uv run just

Setup

  1. Clone this repository:

    git clone https://github.com/tsvikas/hanagram.git

  2. Set up the development environment:

    cd hanagram
uv run just prepare

Development Workflow

Code Quality Tools

  • Format code: uv run just format (runs all the formatting tools)
  • Lint code: uv run just lint (runs all the linting tools)
  • Format and lint code: uv run just quick-tools (runs quick formatting and linting tools)
  • Run tests: uv run just test (runs pytest)
  • Run pre-commit tests: uv run pre-commit run. This also runs on each commit.
  • Run all checks: uv run just format lint test

Running Individual Tools

You can run specific tools directly:

uv run black
uv run ruff check
uv run mypy
uv run pytest
uv run pre-commit run