instructions for contributing
Opened this issue · 3 comments
Specifically, how to set up project locally (install deps, run tests). I'm used to setting up apps, not libraries, so my background is using requirements.txt or pyproject.toml and pip or Poetry to install those deps, so apologies if this issue covers something that would be obvious to a library developer.
@zachvalenta There are no requirements or dependencies other than colorama to make it work on your machine locally. So you can just fork and clone the project on your machine. Then run the command pip install colorama to install colorama. And then you can start working on the project.
It would be much appreciated if you would use black to format the code before pushing so that it would be easier for the owner to merge your contribution.
To install black run:
pip install black
And to format, run:
black path_to_file
Hope my comment would help you! :)
colorama is a dependency, no?
Oh, I am really sorry. I totally forgot to mention about colorama being a dependency.