We welcome the contribution to the package!
If you're interested in seeing who has already contributed to this project, please visit our Contributors page. We appreciate all contributions and look forward to see your name on that list!
For the detailed explanation of the development workflow, please visit the corresponding links below.
Fork and clone.
Go to the RAD-tools repository and click on the "Fork" button. Now you have your own copy of the RAD-tools repository in your GitHub account.
Clone your copy of the repository to your local machine:
If you are using ssh-key:
git clone firstname.lastname@example.org:your-username/rad-tools.git
If you are not using ssh-key:
git clone https://github.com/your-username/rad-tools.git
Change the directory:
Add the upstream repository:
git remote add upstream https://github.com/adrybakov/rad-tools.git
Set up the environment.
We recommend to use virtual environment. Once the virtual environment is created, you can install requirements:
For the package development:
pip install -r requirements.txt
For the docs:
pip install -r docs/requirements.txt
For the tests:
pip install -r utest/requirements.txt
Develop the contribution.
Submit your contribution.
Push the changes to your forked repository:
git push origin feature-name
Go to your forked repository on GitHub and click on the green "Compare & pull request" button. Describe your contribution and submit the pull request. Please mention the issue number if it is related to any.
Review and merge.