Contributing

🚧 Work in Progress 🚧

Setting up your fork

First fork the repo on github. When you have created your fork, clone it so that you have a local copy:

git clone https://github.com/your-github-username/cellx.git
cd cellx

Next, you need to link it to the main repo:

git remote add upstream https://github.com/quantumjot/cellx.git

This is important, because it enables you to keep your fork up-to-date with everyone's changes.

Finally, all the code needs to be free from errors and in the same style. This is achieved by setting up the pre-commit hooks:

pre-commit install

Now, when you commit changes to your branch, they will automatically be checked for style and errors. You may need to install pre-commit:

pip install pre-commit

If your want to contribute your new feature, make sure to make a new branch:

git checkout master -b your-branch-name

Use the following to determine which branch you're on:

git status

The following commands will update the main branch of your fork:

git checkout master
git pull upstream master

You can then update any branches by:

git checkout your-branch-name
git merge master