There are several ways you could possibly contribute. I haven't put them as issues yet. If you would be interested in contributing, write to me at [email protected]. I will be putting up some issues soon which you can take up by commenting on the issue.
Here are the steps you can follow to make feature changes and contribute:
-
Fork the repository
-
Clone it locally using git command
git clone https://github.com/{your username}/GreyNSights.git -
Install requires packages (recommended to perform this in a seperate virtualenv or conda environment)
pip install requirements.txt -
Install the package
python3 setup.py install -
Ensure tests are running by running pytest in the root of repository
pytest -
Make the required changes
-
Run precommit hook
pre-commit run --all-files -
Test if the changes are okay by running pytest again
-
Add it to git, commit it and push it.
-
Make a pull request to this repository