Thank you for your interest in contributing to Solathon! We welcome contributions from the community to help make this project better.
Before you start contributing, please take a moment to review the following guidelines.
We expect all contributors to act professionally and respectfully, and we expect our social channels to be a safe and enjoyable environment for all.
-
Fork the repository and create your branch from
master:git checkout -b feature/your-feature-branch
-
Make your changes and ensure that they follow the project coding standards.
-
Write tests for your changes to ensure the functionality is correct.
-
Ensure your code passes linting and tests:
poetry run pytest
-
Commit your changes with a clear and concise commit message:
git commit -m "Add a brief summary of your changes" -
Push to your branch:
git push origin feature/your-feature-branch
-
Create a pull request to the
masterbranch.
To set up your development environment, follow these steps:
-
Install the Poetry version used by CI (the project uses Poetry 2's PEP 621 metadata support):
pip install poetry==2.4.2
-
Clone the repository:
git clone https://github.com/GitBolt/solathon.git cd solathon -
Install the project, development tools, and optional QR dependencies:
poetry install --with dev --all-extras
-
Run the complete local quality gate:
poetry run ruff format --check . poetry run ruff check . poetry run pytest poetry run pip-audit poetry check --lock poetry build