termgraph icon indicating copy to clipboard operation
termgraph copied to clipboard

instructions for contributing

Open zachvalenta opened this issue 5 years ago • 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 avatar Feb 24 '20 04:02 zachvalenta

@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! :)

AdityaTaggar05 avatar Nov 04 '20 10:11 AdityaTaggar05

colorama is a dependency, no?

zachvalenta avatar Nov 11 '20 01:11 zachvalenta

Oh, I am really sorry. I totally forgot to mention about colorama being a dependency.

AdityaTaggar05 avatar Nov 15 '20 14:11 AdityaTaggar05