Creating new repositories
Start each repository with a README template like the one below:
# [Project name] Summary of what this project is, and why it's needed. ## Maintainers [main maintainer] (primary) and [secondary maintainer] (secondary) ## Design principles Write here the main design decisions behind this project, so that a person wanting to get familiar with this code will understand the principles. ## Developer guidelines Write here what to consider and take into account before merging changes into this repo, or tips while developing. ## Development If relevant, explain here how to get a development version of the project up and running. Also add information on how to run tests, coverage checkers, linters, etc. ## Tests before merging changes Write here the manual or semi-automated tests that should be performed before merging any changes to this repo, along with instructions to easily reproduce the results.
The containers repository is a good example of how to complete the README template.