Standard Readme

Standard Readme Style

Your README file is normally the first entry point to your code. It should tell people why they should use your module, how they can install it, and how they can use it. Standardizing how you write your README makes creating and maintaining your READMEs easier. Great documentation takes work!

Gitflow branch naming convention and rule

branch name is small letter only

• Master branch: production-ready state branch ( master )
• Hotfix branch: naming convention ( hotfix/main-anything ) For first default branch only or ( hotfix/anything-anything )
• Release branch: naming convention ( release/main-anything ) For first default branch only or ( release/anything-anything )
• Develop branch: naming convention ( develop/main-anything ) For first default branch only or ( develop/anything-anything )
• Feature branch: naming convention ( feature/main-anything ) For first default branch only or ( feature/anything-anything-anything ) or (feature/frontend-anything-anything )

Table of Contents

• Background
• Install
• Usage
  • Generator
• Badge
• Example Readmes
• Related Efforts
• Maintainers
• Contributing
• License

Background

Install

Usage

Example Readmes

To see how the specification has been applied, see the example-readmes.

Related Efforts

Maintainers

Contributing

Contributors

This project exists thanks to all the people who contribute.

License

MIT © Richard Littauer