Skip to content

Contribution Guidelines

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

  1. Fork the repository on GitHub and clone your fork to your local machine: 

    git clone https://github.com/your-username/Validoopsie.git

  2. Use the Makefile to set up the development environment: 

    make setup

This will create a virtual environment and install all dependencies.

Alternatively, you can install dependencies manually: 

uv venv
uv sync --all-groups

  1. Create a new branch for your feature or bugfix: 
    git checkout -b my-feature-branch
  2. Make your changes in the new branch.
  3. Run tests and linters to ensure quality: 
    # Run all tests and linters
make all

# Or run them separately
make lint
make test
  4. Commit your changes with a descriptive commit message: 
    git commit -m "Add feature X"
  5. Push your branch to your fork on GitHub: 
    git push origin my-feature-branch
  6. Open a pull request on the main repository.

Submitting Changes

  1. Ensure that your code follows the project's Style-guide (basically ruff).
  2. Ensure that all tests pass.
  3. Open a pull request with a clear title and description of your changes.
  4. Be prepared to make changes requested by reviewers.

Style Guide

  • 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!