Things that belong in here include:
- General guidelines, e.g.
- Code style
- Testing principles
- High level cross-project documentation, e.g.
- "This is how these three services interact"
- Infrastructure
- Links to other pieces of documentation, e.g.
- "We handle invoicing with the pyinvoicer service, and here is a link to its README"
Things that do not belong in here include:
- Large chunks of code
- These belong in a code repo like the rest of our code so they can be tested etc.
- "Project documentation"
- If it belongs with a specific lump of code, put it there
- If it belongs with a specific GitHub repo, put it in there
- Document something as close to it as possible