Repo status badges

We treat every new commonality project repository as a reference repository in order to improve our code; engage the open source community; and delivery better products. commonality/readme-inspector is no different.

Table of contents

• 1. README.md
  • 1.1. Product status
  • 1.2. RunKit playground notebooks
• 2. Project dashboard
• 3. Code quality
  • 3.1. Pull request quality summaries
  • 3.2. Source code (and commit message) conventions, quality, vulnerability, and testing tools
  • 3.3. Automated status checks

1. README.md

1.1. Product status

Every repository's README.md provides real-time, core product status badges that declare

1. The product's FOSS license
2. Third-party FOSS license obligation status (with FOSSA )
3. Security vulnerability status (with the Node Security Program and Snyk )
4. Production and development dependency drift status (with David DM )
5. Build and test status on MacOS, Ubuntu, and Windows (with Travis CI and Appveyor )
6. Test coverage percentage (with Codacy )
7. Code quality status (with Codacy )
8. Maintenance status
9. NPMS score
10. Downloads per month

---

Inspect GitHub (Enterprise) repositories for the presence and quality of READMEs.

---

1.2. RunKit playground notebooks

We link to interactive RunKit Notebooks as soon as our Node.js-based products are available on NPM, so you can try before you rely.

2. Project dashboard

We openly guage community activity and engagement on our /docs/project/README.md page.

Measure	Status/info
Community engagement
Issues
Pull requests and merges
Product releases, maintenance, and size

3. Code quality

3.1. Pull request quality summaries

Our PULL_REQUEST_TEMPLATE.md provides SonarCloud badges to help engineers quickly assess any major code smells or technical debt.

Measure	Scores
Quality gate
Complexity
Duplications
Issues
Maintainability
Reliability
Security
Test coverage

3.2. Source code (and commit message) conventions, quality, vulnerability, and testing tools

We plainly reference our standards and conventions, as well as the tools we use to enforce those standards.

Code Style	Linters	Test frameworks	Git commit messages
Standard JS user guide	ESlint user guide	Jest user guide	Conventional Commits

3.3. Automated status checks

Finally, we require multiple passing status checks with every push to a pull request.