Skip to content

Latest commit

 

History

History
72 lines (52 loc) · 1.75 KB

CONTRIBUTION.md

File metadata and controls

72 lines (52 loc) · 1.75 KB

Contribution Guidelines

Follow this guide to start contributing to RAIN

Configuring

  • Fork the repository to your github account by pressing the 'Fork' button on the top right corner of the screen when you open the repo

  • Clone your fork to your computer using :

     git clone [email protected]:your-github-username/RAIN.git

  • Set the remotes :

     git remote add origin [email protected]:your-github-username/RAIN.git
 git remote add upstream [email protected]:ERC-BPGC/RAIN.git

  • Updating the forks:

     git fetch upstream

Contibuting

  • Creating a new branch for your contributions:

     git checkout -b name-of-your-bugfix-or-feature

  • Remember to update your local repo before starting the work everytime by using :

     git pull upstream main

  • You can create a new branch where you will make the changes using :

     git checkout -b #branch_name

  • Make sure the changes, additions etc. are documented propoerly in CHANGELOG.rst of the package.

This will push the changes to the forked remote repo. Once this is done, you can open 'Pull Request' (PR) to the repo which will then be reviwed and merged after making some changes (if any)

Code Style

If you add any new code in the package, use Google Style to write the documentation.

  • To format code use the following:

     isort .
 black .
 flake8 .

  • After making the final changes, you can push the new changes using :

     git add .
 git commit -m 'comments'
 git push origin #branch_name