GitHub template repository with best practices

👥 Working Groups Governance
1

Hi,

I’ve been working on preparing a template repository for GitHub trying to follow some recommendations and best practices to build sustainable projects.

GitHub Best Practices Template

The repository currently provides some indications (and templates) for:

  • Project Description
  • Contributing guidelines
  • Code of Conduct
  • Governance rules
  • License
  • Code owners in your project
  • Templates for your issues/pull requests
  • Security policy
  • Fundings file
  • Citation

The objective is to provide a nice scaffolding solution for any project. Developers would only have to use the repository as template and adapt and fill the gaps in the templates.

Any comment would be more than welcome!

3 Likes
2

I don’t think it’s just about the project documentation, but also about the nature of the project.

Here’s some fun reading from Sophie Huilian Qiu and Bogdan Vasilescu’s lab: https://dl.acm.org/doi/pdf/10.1145/3359224

1 Like
3

Thanks @RichardLitt ! I remember having read that paper, I’ll revisit it :nerd_face:

4

Also, this is old, but this is what I used to use when I audited repositories full-time. audit-templates/audit-template.md at dd837d08c357b1bff09fca80269fdb59f8719a74 · mntnr/audit-templates · GitHub

2 Likes
5

oldie but goldie! thanks again!

6

Thanks for sharing your checklist!

2 Likes
7

In the past I contributed to

8

Hi Ryuno-Ki,

thanks a lot! those indications & checklist are quite useful to guide the writing of readmes. I’ll review it to see how to enrich our proposal, thanks again!

Cheers,