README
How should the opensource projects readme look like?
All opensource projects must have similiar README; as it will be a source of "attraction"
So, we need to define a format and then ensure its followed:
Sections
We should have following sections
0. Icons (Optional) / Badges
Different icons e.g. build, version, tech, docker downloads?
you can look in references for inspirations
1. Introduction
e.g. https://github.com/jtblin/kube2iam#kube2iam
2. Context
e.g. https://github.com/jtblin/kube2iam#context
3. Problem Statement
e.g.https://github.com/jtblin/kube2iam#problem-statement
4. Solution
e.g. https://github.com/jtblin/kube2iam#solution
Technology Stack
What technology stack has been used
Backend
If it has backend then what technologies have been used at different layers?
Frontend
If it is frontend then what technologies have been used?
Infrastructure
How it can be deployed? docker or not?
Testing
How was testing done? Put numbers e.g.
- Number of automated tests?
Security
How was security implemented?
ScreenShots
If it has frontend; then run it and add screen shots.
5. Usage
Running
How to run it?
Building
How to build it?
e.g. https://github.com/cloudposse/bastion#usage or https://github.com/jtblin/kube2iam#usage
NOTE From 6 to 10 they will be generic!
6. Help
e.g. https://github.com/cloudposse/bastion#help
7. Contributing
e.g. https://github.com/cloudposse/bastion#contributing
8. Changelog
e.g. https://github.com/cloudposse/bastion#change-log
9. License
e.g. https://github.com/cloudposse/bastion#license
10. About
https://github.com/cloudposse/bastion#about THIS MUST HAVE AN IMAGE LIKE THIS ONE https://github.com/AngularClass/angular-starter#netlify
References
Look these for inspirations: