consistent developer documentation

datactive / bigbang

Scientific analysis of collaborative communities

http://datactive.github.io/bigbang/

MIT License

149 stars 52 forks source link

Closed npdoty closed 3 years ago

npdoty commented 3 years ago

Let's have a Development section for the readme documentation with at least:

[x] how to run the unit tests (pytest tests/unit/)
[x] how to install/run pre-commit hooks for formatting
[x] docstrings and other documentation expectations
[x] test coverage to aim for (no requirements yet) and how to organize/categorize tests