Build Status, Code Coverage, PR stats/time frame, Project status, etc.
What project is this project addressing?
What is the architectural design of this project? Diagrams are great content here.
Who needs it for what purpose? What problem / pain does this solve?
Does this project have a special ability or functionality comparative projects do not?
Please see CODE_OF_CONDUCT.md.
Please see CONTRIBUTING_GUIDELINES.md.
Please see DEVELOPMENT.md.
Upcoming planned project changes and feature adds.
- A list of items
- required to run
- the project (pre project cloning).
- Do not include
- project dependencies
- installed via a
- package manager such
- as compose, npm, gem, etc.
A collection of errors and corrective actions within the scope of this project.
git clone ...echo -e "Some commands\n
to configure\n
the project.\n"echo -e "The commands\n
to run\n
the project."echo -e "You guessed it\n
the command to stop
the project.\n"This project follows SemVer 2.0 tagging pattern.
Given a version number MAJOR.MINOR.PATCH, increment the:
1. MAJOR version when you make incompatible API changes,
2. MINOR version when you add functionality in a backwards compatible manner, and
3. PATCH version when you make backwards compatible bug fixes.
Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.
-
Adding visual aids to any / all the above sections above is recommended.
-
Contributes sources from all-contributors.
-
ROADMAP example from all-contributors/all-contributors.
-
Based on README Maturity Model; strive for a Level 5
Product-oriented README. -
This Code of Conduct is adapted from the Contributor Covenant, version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
-
CONTRIBUTING.md is based on the Ruby on Rails Contributing document, credit is due to them.
-
LICENSE sources from:
-
SECURITY.md based from ISARA Radiate Security Solution Suite 2.0 Security Issues.