Skip to content
Greg Swindle edited this page Apr 24, 2018 · 10 revisions
commonality commonalixy

Welcome to the readme-inspector wiki!

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

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

Status checks

Git Git logo

Terminal CLI snippets for git.

  1. Git tips
  2. Git notes

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.

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

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

Clone this wiki locally