Contribution Guide

Setting up the project

Clone the project into your machine

git clone https://github.com/prakash-O4/magiccommits.git

Activate virtual environment

python3 -m venv .venv

Activate virtual environment

source .venv/bin/activate

Install the dependencies using pip:

pip3 install -r requirements.txt

During development, to automatically rebuild the package on file changes:

pip3 install -e .

If you want to run the package outside of venv then you can build the executable file which will be stored inside the dist/ folder

python3 -m build --sdist

After building the execcutable, now you can install the file by executing

pip3 install /path/to/dist/***.gz

This will install the magiccommits in your machine locally and you can execute globally.

If you faced any issue then feel free to open PR in https://github.com/prakash-O4/magiccommits/issues.