Always nice to have a status badge of all your pipelines in the readme

A short description of project

Something else to say about project

Sometimes you need a longer description to discuss about the project before developers get started working on the project

Sometimes there are libs that are necessary to run the projects

• Some lib to install
• Some other setup required maybe a database

Installation steps are necessary so go through each step to do so

Commands would be good please

Small summary of the kind of testing that exists in this repository

Here is how you run linting test

Special commands so you don't feel lost in doing so 

Here is how you run unit tests :-P

Yes, more commands, this is the real deal now

Here is how you run unit tests :-P

Yes, more commands, this is the real deal now

Here is how you run unit tests :-P

Yes, more commands, this is the real deal now

Omg foreals, I have to do deployment notes too??? Yep...

Make sure to write notes about deployment, is it just merging to master to trigger Github Actions Pipeline

It's always nice to have some diagrams that will help show the high level design. Only do this when appplies

Sometimes is nice to tell people to go to another documentation :-( to make sure this readme doesn't get too long. So might as well create a contribution guidline markdown file and link it here. CONTRIBUTING.md this will help you know the rules of how to contribute.

• Some dude that wants credit - Yep I did the whole project, no one helped. Sigh.. I'm joking it was a team effort - Here is my profile

It is best to just have a code owners setup. Checkout Setup code owners in github repo

Most like MIT License because we like open sourcing but it can be whatever license you like - Again we want to put the license in a different file to not make the readme too big LICENSE.md

• Do we need to give credit to other people or groups? May be fun to share the love here.