Skip to content

Home

Jump to bottom Edit New page
Greg Swindle edited this page Apr 25, 2018 · 10 revisions
commonality commonalixy

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

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
  3. Security vulnerability status
  4. Production and development dependency drift status
  5. Build and test status on MacOS, Ubuntu, and Windows
  6. Test coverage percentage
  7. Code quality status
  8. Maintenance status
  9. NPMS score
  10. Downloads per month

readme-inspector NPM version GitHub release

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

The MIT License FOSSA Status NSP Status Known Vulnerabilities
Dependency Status Development Dependency Status
MacOS and Ubuntu build statuses Windows build status Coverage percentage Codacy code quality Maintenance
NPMS score NPM downloads per month

Project dashboard

dashboard Community activity and engagement, as well as project health.

Measure Status/info
Community engagement contributor-count
author
commits-per-year
last-commit
NPM downloads per month
used-by
github-forks
github-stars
github-watchers
Issues issue-opened issues-open
megaphone breaking-change-issues-open
bell feature-issues-open
bug defect-issues-open
issue-closed issues-closed
Pull requests and merges prs-open pull-requests-open
git-merge pull-requests-closed
Product releases, maintenance, and size last-release-date
maintenance
code-size-in-bytes
repository-size

Code quality summary

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

Measure Scores
Quality gate Overall Quality
Complexity Complexity
Cognitive complexity
Complexity per Class
Complexity per file
Complexity per Function
Duplications Duplications
Issues Issues
Maintainability Code smells
Maintainability
Technical debt
Reliability Reliability
Security Security
Vulnerabilities
Test coverage Coverage Status
Coveralls coverage

Status checks

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

status checks

Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.

Home Wiki Home

Git Git logo

Terminal CLI snippets for git.

  1. Git tips
  2. Git notes

Pre-release checklist

tasklist This checklist—adapted from bahmutov/npm-module-checklist link-external—provides useful tips to ensure your module is ready for production deployment and publication.

Repo status badges

verified Openly declare the health of your product, project, community, and source code with these essential badges. (GitHub SaaS only.)

UX Cheat-sheets

Info Icons, images, gists, code snippets, etc.

  1. Architecture Decision Record status labels
  2. Octicon cheatsheet
  3. Project status badges
  4. TechRadar labels

Resources

Telescope Stellar languages, frameworks, platform, techniques, and tools.

Clone this wiki locally