Setting Up Your Development Environment
Prerequisites
- Python 3.10 or higher
- Pip
- Git
Setup
-
Clone the repository:
-
Create and activate a virtual environment (recommended):
-
Install dependencies including development tools:
-
Install Pre-Commit Hooks:
Running Tests
Testing ensures that your contributions work as intended and do not break existing functionality.
Install Test Dependencies
Ensure all test dependencies are installed.
Run Tests
Run the test suite using Pytest.
Check Test Coverage
Check the test coverage to ensure comprehensive testing.
Submitting Changes
Create Branch
Create Branch
Create a branch for your work:
Commit Changes
Commit Changes
Commit your updates:
Push Branch
Push Branch
Push your branch:
Open PR
Open PR
Open a pull request on GitHub:
Code Style and Linting
This project usesruff
for linting and code formatting. Configuration for this tool can be found in pyproject.toml
.
Before committing your changes, please check and fix linting errors: