Recommendations and Resources
Recommendations and Resources¶
Checklist for Setting your Project¶
Create README and Vision file
Create a project roadmap to share
Develop a CONTRIBUTING file
Select & adopt a Code of Conduct with reporting & enforcement guide
You can also create a page dedicated to help your community members explore your project and its resources (see Django Documentation).
These documents are also effective tools for community building as it supports early contributors to get easily onboarded and makes it easy for past contributors to return.
GitHub encourages collaboration practice in their community guidelines. The insights tab of your GitHub project provides a section called “Community” that includes a list of recommended documents that your project should have.
Resources for Advanced Structure for Data Analysis¶
See the Research Compendia chapter.
Max Joseph, How (and why) to make a research compendia. (2020, March 19). Presentation.
Nüst, D., Boettiger, C., & Marwick, B. (2018). How to Read a Research Compendium. arXiv, 1806.09525. Manuscript.
Perez-Riverol, Y., Gatto, L., Wang, R., Sachsenberg, T., Uszkoreit, J., da Veiga Leprevost, F., Christian Fufezan, Ternent, T., Eglen, S. J., Katz, D. S., Pollard, T. J., Konovalov, S., Flight, R. M., Blin, K., Vizcaíno, J. A. (2016). Ten Simple Rules for Taking Advantage of Git and GitHub. PLoS Comput. Biol., 12(7), e1004947. doi: 10.1371/journal.pcbi.1004947. Peer-reviewed Article.
Venigalla, A. S. M., & Chimalakonda, S. (2021). What’s in a GitHub Repository? – A Software Documentation Perspective. arXiv, 2102.12727.
Marwick, B., Boettiger, C., & Mullen, L. (2018). Packaging Data Analytical Work Reproducibly Using R (and Friends). American Statistician, 72(1), 80–88. doi: 10.1080/00031305.2017.1375986