github README template

Every module should have a README, following this template should remove friction from the process.

Brief of the project

One liner + link to confluence page

Screenshot of UI - optional

stack - optional

How to build and run the code/app

High level overview of system architecture

How to run the development environment

Coding style convention ref optional, eg which linter to use

Linting, github pre-push hook - optional

How to run build

How to carry out tests

How to deploy the code/app into test/staging/production

Last updated 6 years ago