README template¶
Lede: One line, 25 words of less describing the thing.
One paragraph with concise summary and potentially a list, with both linking to more information where appropriate.
Usage¶
Installation¶
Describe how to get your project running.
Pre-requisites¶
- hardware
- software
- permissions
- etc
Configuration¶
Troubleshooting¶
Setup¶
Running the tests¶
Contributing¶
- Fork it (https://github.com/yourname/yourproject/fork)
- Create your feature branch (
git checkout -b feature/fooBar
) - Commit your changes (
git commit -am 'Add some fooBar'
) - Push to the branch (
git push origin feature/fooBar
) - Create a new Pull Request
Other things to include?¶
i- todo - changelog - releases - configuration - environments - prod - staging - dev - deployment - troubleshooting - monitoring/alerting - metrics