github README template

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

https://gist.github.com/pietrop/a89d96870b843c6f07b8ad12a9c17dde

Brief of the project

One liner + link to confluence page

Screenshot of UI - optional

Setup

stack - optional

How to build and run the code/app

Usage

System Architecture

High level overview of system architecture

Development env

How to run the development environment

Coding style convention ref optional, eg which linter to use

Linting, github pre-push hook - optional

Build

How to run build

Tests

How to carry out tests

Deployment

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

Link to trello card: github README template

Labels

Last updated