- Motivation
- Additional documentation
- How to set up the dev environment
- Testing
- How to run it locally
- How to deploy/install it
- Backlog
- Troubleshooting & FAQ
- Why was this repository/project/component created?
- What exact problem does it solve?
- Who are the stakeholders involved?
Please enumerate and describe the main features offered by this service/component/script/whatever.
E.g. architecture diagrams if needed.
- Please explain the common prerequisites to run either the tests or the component locally (e.g. having a specific Maven version installed for a Java project).
- It might be a good thing to follow this idea.
- Manual tests vs Automated tests
- Unit vs Integration vs End-to-end tests
- Precise instructions, with the specific commands, to run whatever tests are possible to run, including all the prerequisites.
- Precise instructions, with the specific commands, to run the component/service locally.
- If there are scripts, name them, explain how to run them, their goal, etc. If that explanation is inside the script itself, at least mention here that they exist.
- What is it needed to deploy this component? How to install it?
- Including dependencies needed, etc.
Where and how do people additional things to work on for this component? Just an issue in the GitHub repo? Is there a specific Trello/GitHub project somewhere?
TBD