search

mnets / pymnet

The original library for analyzing multilayer networks.
https://mnets.github.io/pymnet/
GNU General Public License v3.0
118 stars 24 forks source link

[REVIEW] Improve contribution guide #37

Closed nwlandry closed 3 weeks ago

nwlandry commented 3 weeks ago

I see that there is a brief contribution guide in the README. It would be helpful to add a few issues with the "Good first issues" (For example, see NetworkX, and link to this label in the contribution section.

In the future, it would be great to make the contribution guide a bit more step-by-step (e.g., fork the repository, make your changes, check test coverage, format code, add docs (is there a docstring format?), make a PR, etc.)

openjournals/joss-reviews#6930

arashbm commented 3 weeks ago

@dataspider I added a simple HACKING.md with some of the essentials but will have to add some more information, e.g. formatting commands, code coverage etc.