A good template for github repos with best practices adoption.
- ✅ All github community standards are checked off
- ✅ gitattributes based on gitattributes
- ✅ gitignore with comments
- ✅ Issue Templates
- ✅ PR Template
- ✅ CODEOWNERS that is self-documented
- ✅ justfile with command line workflow for pull requests
- ✅ Github Action for Markdownlint
- ✅ A few extra labels for issues
- ✅ README with badges
- To use this template, you can create a new repository by clicking on "Use this template" button.
- Remember to replace any
chicks-net,fini-net, andtemplate-reporeferences with the right values for your project. (Github templates do not offer variable substitution, but we still have to call them templates for some reason.) - Ditch the "Template Status", "Usage", and "Kudos" sections in the
README.md.just clean-readmewill give you a clean README, but there are other files to fix.
Here is a nice checklist of things to consider with a new repo.
- Code of Conduct
- Contributing Guide includes a step-by-step guide to our development processs.
I went with the GPL2 license, but the MIT license is also worth considering.
- Jose Gracia Berenguer did a great job with their project-template repo. This looks like a student project, but it is one of the best templates I've found on github.
- Cookiecutter Data Science is cool, but it isn't actually a template repo.
- gh-best-practices-template
is doing great at checking off all of the boxes. They've including funding and citations
which I haven't tried yet. I'm not a fan of how all of the Markdown files are in the
root directory. I definitely prefer stuffing those under
/.githubfor a cleaner root directory.
- I've really enjoyed building projects with just.
- The GitHub CLI makes browser-free workflows not only possible, but fun.