Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
31 lines (19 loc) · 1003 Bytes

CONTRIBUTING.md

File metadata and controls

31 lines (19 loc) · 1003 Bytes

Contributing to PixelMap

Thank you for your interest in contributing to PixelMap!

Ways to Contribute

Bug Reports

Found a bug? Please open an issue with:

  • A clear, descriptive title
  • Steps to reproduce the issue
  • Expected vs. actual behavior
  • Your environment (OS, Python version, browser if using GUI)

Feature Requests

Have an idea? Open an issue describing the problem and your proposed solution.

Pull Requests

For significant changes, please open an issue first to discuss your approach.

  1. Fork the repository
  2. Create a branch with a descriptive name (e.g., feature/your-feature-name or fix/bug-description)
  3. Make your changes and run tests: pytest
  4. Push to your fork and open a pull request to the dev branch

Code Style

We use Ruff for linting and formatting. Run ruff check . and ruff format . before submitting.