Skip to content

Latest commit

 

History

History
43 lines (32 loc) · 832 Bytes

CONTRIBUTING.md

File metadata and controls

43 lines (32 loc) · 832 Bytes

CONTRIBUTING

GETTING STARTED

I recommend setting up a virtual enviroment since some of the packages are not compatible with python 3.13.1

virtualenv -p python3.12.0 .venv
source .venv/bin/activate 
pip install -r requirements.txt

If I am missing a requirement please let me know.

Continous Development

Installing the package in development mode:

pip install . -e

1. Fork & clone

  • Click on the Fork button on GitHub
  • Clone your fork
  • Add the upstream repository as a new remote

2. Create a pull request

git checkout -b my_feature_branch
git commit -s
git push my_feature_branch

3. Update your pull request with latest changes

git checkout main
git pull upstream main
git checkout my_feature_branch
git rebase main
git push -f my_feature_branch