Thank you for considering contributing to Validoopsie! The idea of one spending their time on contribution to this project is wild for me, so I appreciate every minute you spend on it.
- How to Contribute
- Setting Up the Development Environment
- Running Tests
- Submitting Changes
- Style Guide
- Fork the repository on GitHub.
- Clone your fork to your local machine:
git clone https://github.com/your-username/Validoopsie.git
- Create a new branch for your feature or bugfix:
git checkout -b my-feature-branch
- Make your changes in the new branch.
- Run the tests to ensure that your changes do not break anything:
pytest
- Commit your changes with a descriptive commit message:
git commit -m "Add feature X"
- Push your branch to your fork on GitHub:
git push origin my-feature-branch
- Open a pull request on the main repository.
- Ensure you have Python 3.9 or higher installed.
- Install the required dependencies (I prefer using
uv
for this):uv sync --all-extras
We use pytest
for running tests. To run the tests, execute the following command:
pytest
- Ensure that your code follows the project's Style-guide (basically ruff).
- Ensure that all tests pass.
- Open a pull request with a clear title and description of your changes.
- Be prepared to make changes requested by reviewers.
- Follow the PEP 8 style guide for Python code.
- Use type hints where appropriate.
- Ensure that your code is well-documented.
- Use meaningful variable and function names.
Thank you for your contributions!