datactive / bigbang

Scientific analysis of collaborative communities

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

MIT License

149 stars 52 forks source link

overview of how bigbang code is organized and how to use the library #502

Open npdoty opened 2 years ago

npdoty commented 2 years ago

The API documentation is organized by file/library, which makes sense, but I'm not sure how easy that is for people to understand. Should we have an overview of how the code is organized so that someone new to the project knows what to look for where? E.g. mailing list crawling is done within these 4 files, archives and analysis is in these, these files were experimental and aren't regularly used, etc.

sbenthall commented 2 years ago

498 - Visualization code is currently spread ad hoc throughout the module. If it were better organized, it would be easier to describe the organization

datactive / bigbang

overview of how bigbang code is organized and how to use the library #502

322 - Contributor guidelines. Should tell people where to put contributions.

498 - Visualization code is currently spread ad hoc throughout the module. If it were better organized, it would be easier to describe the organization