Contribution guidelines

Make sure up-to-date with master

git pull origin master

Make branch

git checkout -b branch-name

Branch names should follow the standard of develop-myfeaturename

Commit to branch

git push origin branch-name

Merging a develop branch to master

Please rebase your branch to master before submitting a pull request, as this will enable you to go through, step-by-step, and resolve any merge conflicts. For Jupyter notebooks, nbdev's nbdev_fix_merge can be very helpful to resolve conflicts.

git fetch origin
git rebase origin/master

Make a pull request

git request-pull branch-name master

Commit hooks

The following commit hooks are being considered for implementation.

1. Automatically clear Jupyter notebooks before commit to reduce conflicts when rebasing/merging
2. Delete .pyc files when checking out a notebook
3. Automatic code formatting
4. Ensure descriptive commit history