---
title: "Recommendations and Resources"
source: The Turing Way
source_url: https://github.com/the-turing-way/the-turing-way
licence: CC-BY-4.0
domain: data-and-analysis
subdomain: turing-way
date_added: 2026-04-25
---

(project-repo-recommendations)=
# Recommendations and Resources

(project-repo-recommendations-checklist)=
## 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](https://docs.djangoproject.com/)).

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 Insights

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.

```{figure} ../../../../figures/community-profile.png
---
name: community-profile
alt: Image of a checklist in Community section of Insights tab of a GitHub project.
---
Checklist of recommended documents
```

(project-repo-recommendations-advanced)=
## Resources for Advanced Structure for Data Analysis

- See the {ref}`rr-compendia` chapter.
- Max Joseph, [How (and why) to make a research compendia](https://mbjoseph.github.io/intro-research-compendia/#1). (2020, March 19). Presentation.
- Nüst, D., Boettiger, C., & Marwick, B. (2018). [How to Read a Research Compendium](https://arxiv.org/abs/1806.09525v1). 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](https://journals.plos.org/ploscompbiol/article?id=10.1371/journal.pcbi.1004947). 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](https://arxiv.org/abs/2102.12727v2). arXiv, 2102.12727.
- [The Relationship Between Folder Use and the Number of Forks: A Case Study on Github Repositories](http://citeseerx.ist.psu.edu/viewdoc/summary?doi=10.1.1.650.8150). (2021, July 02).
- Marwick, B., Boettiger, C., & Mullen, L. (2018). [Packaging Data Analytical Work Reproducibly Using R (and Friends)](https://www.tandfonline.com/doi/abs/10.1080/00031305.2017.1375986). American Statistician, 72(1), 80–88. doi: 10.1080/00031305.2017.1375986
