Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
33 lines (22 loc) · 907 Bytes

CONTRIBUTING.md

File metadata and controls

33 lines (22 loc) · 907 Bytes

Contributing to Granite Switch

Thank you for your interest in contributing to Granite Switch!

Getting Started

  1. Fork the repository
  2. Clone your fork and install dependencies: 
    git clone https://github.com/<your-username>/granite-switch.git
cd granite-switch
pip install -e ".[dev]"
  3. Create a feature branch and make your changes
  4. Run tests: pytest tests/ -v
  5. Submit a pull request

Contribution Guidelines

See docs/GIT_WORKFLOW.md for detailed workflow, commit conventions, and code quality standards.

Areas of Interest

  • Bug fixes — Identify and fix issues in the codebase
  • Documentation — Improve tutorials and guides

Code of Conduct

This project follows the Contributor Covenant Code of Conduct. Please read it before participating.

Questions?

Open an issue or start a discussion.