skatkov / yard-markdown
yard plugin to generate markdown documentation
skatkov/yard-markdown holds a health index of 60 out of 100, placing it in the Moderate band. It scores highest on Engineering Quality (74/100) and lowest on Community & Adoption (42/100). It was last updated 82 days ago. A single contributor accounts for most of its recent work.
Software health index
Metrics are grouped into weighted categories on one standardized 1–100 scale. Overall starts as their weighted mean, calibrated against the distribution of the public record so bands carry percentile meaning; when public evidence triggers the High-Risk Jurisdiction Policy, the rating is adjusted and receives an At Risk ceiling of 34.
Score profile
Each axis is a category. The shape matters more than the average — a healthy subject fills the whole shape, while a spike-and-crater profile means strength in one dimension is masking risk in another.
The weighted overall 57 is calibrated to 60 on the published index scale (record calibration 2026-08-02).
Ownership
This repository is owned by a personal account. A single-owner project carries more continuity risk than an organization-backed one.
Package ecosystems
| Registry | Package | Version | Downloads / mo | Versions | Last publish |
|---|---|---|---|---|---|
| RubyGems | yard-markdown | 0.7.1 | - | 20 | 82 days ago |
Metrics by category
Vitality
Is the project alive — is code being written and are releases shipping?
Development activity
How it's scored
| 18/36 | Push recency — last push 82 days ago |
| 2.1/36 | Commit cadence — 3/52 weeks with commits |
| 14.8/18 | Commit volume — 43 commits in the last year |
| 10/10 | OpenSSF Scorecard: Maintained — 30 commit(s) and 1 issue activity found in the last 90 days -- score normalized to 10 |
Inputs used
| commits_last_year | 43 |
| human_commit_share | — |
| days_since_last_push | 82 |
| active_weeks_last_year | 3 |
Release discipline
How it's scored
| 16.2/27 | Ships releases — 19 version tags (no GitHub releases) |
| 36/36 | Release recency — latest release 82 days ago |
| 19.8/27 | Release cadence — a release every ~79.1 days |
| 0/10 | OpenSSF Scorecard: Signed-Releases — no data |
Inputs used
| releases_count | 19 |
| latest_release_tag | v0.7.1 |
| releases_from_tags | yes |
| days_since_latest_release | 82 |
| mean_days_between_releases | 79.1 |
Community & Adoption
Does the project have users, downloads, attention, and a welcoming setup for contributors?
Popularity & adoption
How it's scored
| 20/60 | Stars — 18 stars |
| 0/25 | Forks — 1 forks |
| 0/15 | Watchers — 1 watchers |
Inputs used
| forks | 1 |
| stars | 18 |
| watchers | 1 |
| growth_state | unverified |
| growth_factor_pct | 100 |
| growth_unverified_reason | no_history |
Community health
How it's scored
| 22.5/22.5 | README |
| 22.5/22.5 | License — recognized license (MIT) |
| 0/18 | CONTRIBUTING guide |
| 0/13.5 | Code of conduct |
| 0/7.2 | Issue template |
| 0/6.3 | PR template |
Inputs used
| has_readme | yes |
| has_license | yes |
| readme_badges | — |
| has_contributing | no |
| has_issue_template | no |
| has_code_of_conduct | no |
| readme_badge_services | — |
| has_pull_request_template | no |
Ecosystem adoption (downloads)
How it's scored
| 51.2/80 | Total downloads — 85,183 downloads all-time across rubygems |
| 0/20 | Registry dependents — not reported by this ecosystem |
Inputs used
| packages | yard-markdown |
| dependents | — |
| ecosystems | rubygems |
| total_downloads | 85,183 |
| monthly_downloads | — |
| unverified_packages_excluded | — |
Sustainability & Governance
Will the project survive its people — bus factor, responsiveness, who backs it, and package upkeep?
Maintainer resilience (bus factor)
How it's scored
| 9/54 | Bus factor — 1 contributor(s) cover half of all commits |
| 0.3/22.5 | Commit distribution — top contributor authored 99% of commits |
| 2.7/13.5 | Contributor breadth — 2 contributors |
| 0/10 | OpenSSF Scorecard: Contributors — project has 0 contributing companies or organizations -- score normalized to 0 |
Inputs used
| bus_factor | 1 |
| contributors_sampled | 2 |
| top_contributor_share | 0.988 |
How it's scored
| 36.8/42 | Issue resolution — 88% of issues closed |
| 28.6/30 | PR acceptance — 21/22 decided PRs merged |
| 0/13 | Newcomer PR acceptance — no first-time contributor's PR decided in 30d |
| 0/15 | OpenSSF Scorecard: Code-Review — Found 0/12 approved changesets -- score normalized to 0 |
Inputs used
| merged_prs | 21 |
| open_issues | 2 |
| closed_issues | 14 |
| prs_merged_7d | — |
| prs_decided_7d | — |
| prs_merged_30d | — |
| prs_decided_30d | — |
| issue_closed_ratio | 0.875 |
| closed_unmerged_prs | 1 |
| first_time_authors_30d | — |
| first_time_prs_merged_30d | — |
| first_time_prs_decided_30d | — |
Ownership & stewardship
How it's scored
| 10/30 | Ownership backing — personal (user) account |
| 0/20 | Verified domain — not applicable to user accounts |
| 15.7/25 | Owner reach — 151 followers of skatkov |
| 25/25 | Track record — 217 public repos, account ~15 yr old |
Inputs used
| followers | 151 |
| owner_type | User |
| is_verified | — |
| owner_login | skatkov |
| public_repos | 217 |
| account_age_days | 5,677 |
Package maintenance
How it's scored
| 25/25 | Published & resolvable — 1 package(s) on rubygems |
| 35/35 | Publish recency — latest publish 82 days ago |
| 20/20 | Version history — 20 published versions |
| 20/20 | Not deprecated — active, not deprecated or yanked |
Inputs used
| packages | yard-markdown |
| ecosystems | rubygems |
| any_deprecated | no |
| min_days_since_publish | 82 |
Engineering Quality
Are baseline engineering and documentation practices in place?
Engineering practices
How it's scored
| 24/24 | CI workflows — 1 workflow(s) |
| 24/24 | Tests present |
| 0/16 | Linter config |
| 0/9.6 | Pre-commit hooks |
| 6.4/6.4 | .editorconfig |
| 20/20 | OpenSSF Scorecard: CI-Tests — 5 out of 5 merged PRs checked by a CI test -- score normalized to 10 |
Inputs used
| has_ci | yes |
| has_tests | yes |
| has_editorconfig | yes |
| has_linter_config | no |
| has_precommit_config | no |
Documentation
How it's scored
| 30/30 | README |
| 0/25 | Documentation directory |
| 15/15 | Documentation / homepage site — https://poshtui.com |
| 10/10 | Repository description |
| 10/10 | Topics — 2 topics |
| 10/10 | Wiki |
Inputs used
| topics | markdown, yard |
| has_wiki | yes |
| homepage | https://poshtui.com |
| docs_site | https://poshtui.com |
| has_readme | yes |
| has_docs_dir | no |
| has_description | yes |
Security
Are visible security and supply-chain practices strong, without unresolved high-risk jurisdiction exposure?
Security posture
How it's scored
| 7.5/7.5 | Binary-Artifacts — no binaries found in the repo |
| 0/7.5 | Branch-Protection — branch protection not enabled on development/release branches |
| 2.5/2.5 | CI-Tests — 5 out of 5 merged PRs checked by a CI test -- score normalized to 10 |
| 0/2.5 | CII-Best-Practices — no effort to earn an OpenSSF best practices badge detected |
| 0/7.5 | Code-Review — Found 0/12 approved changesets -- score normalized to 0 |
| 0/2.5 | Contributors — project has 0 contributing companies or organizations -- score normalized to 0 |
| 10/10 | Dangerous-Workflow — no dangerous workflow patterns detected |
| 0/7.5 | Dependency-Update-Tool — no update tool detected |
| 0/5 | Fuzzing — project is not fuzzed |
| 2.5/2.5 | License — license file detected |
| 7.5/7.5 | Maintained — 30 commit(s) and 1 issue activity found in the last 90 days -- score normalized to 10 |
| 0/5 | Packaging — no data |
| 0/5 | Pinned-Dependencies — dependency not pinned by hash detected -- score normalized to 0 |
| 0/5 | SAST — SAST tool is not run on all commits -- score normalized to 0 |
| 0/5 | Security-Policy — security policy file not detected |
| 0/7.5 | Signed-Releases — no data |
| 0/7.5 | Token-Permissions — detected GitHub workflow tokens with excessive permissions |
| 6.8/7.5 | Vulnerabilities — 1 existing vulnerabilities detected |
Inputs used
| source | openssf_scorecard |
| checks_evaluated | 16 |
| scorecard_version | v5.5.0 |
| checks_inconclusive | 2 |
| scorecard_aggregate | 4 |
Dependency advisories
How it's scored
| 20.2/35 | Direct dependencies free of known advisories — 1 affected: yard 0.9.43 (moderate 5.3) |
| 0/25 | Indirect dependencies free of known advisories — transitive set not separable from development and test dependencies in this scope |
| 40/40 | No advisories left outstanding — no advisory has been public longer than 90 days |
Inputs used
| source | osv |
| advisories | 1 |
| affected_packages | 1 |
| assessed_packages | 52 |
| unassessed_packages | 3 |
| affected_by_severity | moderate 1 |
| direct_affected_packages | 1 |
AI Readiness
How well is the repo equipped to be developed and maintained with AI coding agents? Carries a deliberately small weight (4%): agent tooling is a real maintenance signal, but a repository with none can still reach 100/100.
Agent context & guidance
How it's scored
| 45/45 | Agent instructions — AGENTS.md |
| 0/15 | Machine-readable docs (llms.txt) |
| 0/40 | Legible commit history — no data |
Inputs used
| has_llms_txt | no |
| llms_txt_url | — |
| legible_history_share | — |
| agent_instruction_files | AGENTS.md |
| agent_instruction_max_bytes | 1,311 |
How it's scored
| 0/18 | One-command bootstrap |
| 22/22 | Automated tests |
| 0/11 | Lint / format config |
| 0/11 | Static type checking |
| 10/10 | Reproducible environment — lockfile |
| 0/10 | Demonstrated agent practice — no data |
| 0/8 | Automated maintenance — no data |
| 0/10 | OpenSSF Scorecard: Pinned-Dependencies — dependency not pinned by hash detected -- score normalized to 0 |
Inputs used
| has_nix | no |
| has_tests | yes |
| lockfiles | Gemfile.lock |
| has_dockerfile | no |
| typed_language | no |
| bootstrap_files | — |
| has_devcontainer | no |
| has_linter_config | no |
| typecheck_configs | — |
| agent_commit_share | — |
| toolchain_manifests | — |
| dependency_bot_commit_share | — |
Code legibility for models
How it's scored
| 0/45 | Type-checkable code — Ruby without a type-check config |
| 55/55 | Manageable file sizes — 0/29 source files over 60KB |
Inputs used
| primary_language | Ruby |
| largest_source_bytes | 8,425 |
| source_files_sampled | 29 |
| oversized_source_files | 0 |
Machine-readable interfaces
How it's scored
| 0/40 | API schema (OpenAPI/GraphQL/proto) — not applicable to this kind of software |
| 0/20 | MCP server — not applicable to this kind of software |
| 40/40 | Runnable examples — example |
Inputs used
| example_dirs | example |
| has_mcp_signal | no |
| api_schema_files | — |
| interfaces_expected_of | — |
Key facts
More detail
OpenSSF Scorecard 4.0 / 10
Independent, tool-agnostic security assessment from the open-source OpenSSF Scorecard. Each check rewards a security practice, not a specific vendor's tool. Checks Scorecard could not determine are marked n/a and excluded from the security score (never counted as zero).
| 10 | Binary-Artifacts | no binaries found in the repo |
| 0 | Branch-Protection | branch protection not enabled on development/release branches |
| 10 | CI-Tests | 5 out of 5 merged PRs checked by a CI test -- score normalized to 10 |
| 0 | CII-Best-Practices | no effort to earn an OpenSSF best practices badge detected |
| 0 | Code-Review | Found 0/12 approved changesets -- score normalized to 0 |
| 0 | Contributors | project has 0 contributing companies or organizations -- score normalized to 0 |
| 10 | Dangerous-Workflow | no dangerous workflow patterns detected |
| 0 | Dependency-Update-Tool | no update tool detected |
| 0 | Fuzzing | project is not fuzzed |
| 10 | License | license file detected |
| 10 | Maintained | 30 commit(s) and 1 issue activity found in the last 90 days -- score normalized to 10 |
| n/a | Packaging | packaging workflow not detected |
| 0 | Pinned-Dependencies | dependency not pinned by hash detected -- score normalized to 0 |
| 0 | SAST | SAST tool is not run on all commits -- score normalized to 0 |
| 0 | Security-Policy | security policy file not detected |
| n/a | Signed-Releases | no releases found |
| 0 | Token-Permissions | detected GitHub workflow tokens with excessive permissions |
| 9 | Vulnerabilities | 1 existing vulnerabilities detected |
Direct dependencies 12
| Registry | Package | Version constraint | Manifest |
|---|---|---|---|
| RubyGems | rake | ~> 13.0 | Gemfile |
| RubyGems | minitest | ~> 5.0 | Gemfile |
| RubyGems | minitest-strict | — | Gemfile |
| RubyGems | mutant | — | Gemfile |
| RubyGems | mutant-minitest | — | Gemfile |
| RubyGems | mutex_m | — | Gemfile |
| RubyGems | commonmarker | — | Gemfile |
| RubyGems | redcarpet | — | Gemfile |
| RubyGems | yard | — | Gemfile |
| RubyGems | yard-lint | — | Gemfile |
| RubyGems | sord | — | Gemfile |
| RubyGems | standard | — | Gemfile |
All dependencies 55
Full resolved dependency set from the GitHub dependency graph: 13 direct and 42 indirect (transitive) packages. The transitive closure is complete when the repository commits a lockfile.
| Registry | Package | Version | Relation |
|---|---|---|---|
| RubyGems | commonmarker | 2.8.1 | direct |
| RubyGems | minitest | 5.27.0 | direct |
| RubyGems | minitest-strict | 1.0.0 | direct |
| RubyGems | mutant | 0.16.2 | direct |
| RubyGems | mutant-minitest | 0.16.2 | direct |
| RubyGems | mutex_m | 0.3.0 | direct |
| RubyGems | rake | 13.4.2 | direct |
| RubyGems | redcarpet | 3.6.1 | direct |
| RubyGems | sord | 7.1.0 | direct |
| RubyGems | standard | 1.54.0 | direct |
| RubyGems | yard | — | direct |
| RubyGems | yard | 0.9.43 | direct |
| RubyGems | yard-lint | 1.5.1 | direct |
| RubyGems | ast | 2.4.3 | indirect |
| RubyGems | commander | 5.0.0 | indirect |
| RubyGems | csv | — | indirect |
| RubyGems | csv | 3.3.5 | indirect |
| RubyGems | date | 3.5.1 | indirect |
| RubyGems | diff-lcs | 2.0.0 | indirect |
| RubyGems | erb | 6.0.4 | indirect |
| RubyGems | highline | 3.0.1 | indirect |
| RubyGems | io-console | 0.8.2 | indirect |
| RubyGems | irb | 1.18.0 | indirect |
| RubyGems | json | 2.19.4 | indirect |
| RubyGems | language_server-protocol | 3.17.0.5 | indirect |
| RubyGems | lint_roller | 1.1.0 | indirect |
| RubyGems | logger | 1.7.0 | indirect |
| RubyGems | parallel | 1.28.0 | indirect |
| RubyGems | parlour | 9.1.2 | indirect |
| RubyGems | parser | 3.3.11.1 | indirect |
| RubyGems | pp | 0.6.3 | indirect |
| RubyGems | prettyprint | 0.2.0 | indirect |
| RubyGems | prism | 1.9.0 | indirect |
| RubyGems | psych | 5.3.1 | indirect |
| RubyGems | racc | 1.8.1 | indirect |
| RubyGems | rainbow | 3.1.1 | indirect |
| RubyGems | rbs | 4.0.2 | indirect |
| RubyGems | rdoc | — | indirect |
| RubyGems | rdoc | 7.2.0 | indirect |
| RubyGems | regexp_parser | 2.12.0 | indirect |
| RubyGems | reline | 0.6.3 | indirect |
| RubyGems | rubocop | 1.84.2 | indirect |
| RubyGems | rubocop-ast | 1.49.1 | indirect |
| RubyGems | rubocop-performance | 1.26.1 | indirect |
| RubyGems | ruby-progressbar | 1.13.0 | indirect |
| RubyGems | securerandom | 0.4.1 | indirect |
| RubyGems | sorbet-runtime | 0.6.13163 | indirect |
| RubyGems | standard-custom | 1.0.2 | indirect |
| RubyGems | standard-performance | 1.9.0 | indirect |
| RubyGems | stringio | 3.2.0 | indirect |
| RubyGems | tsort | 0.2.0 | indirect |
| RubyGems | unicode-display_width | 3.2.0 | indirect |
| RubyGems | unicode-emoji | 4.2.0 | indirect |
| RubyGems | unparser | 0.9.0 | indirect |
| RubyGems | zeitwerk | 2.7.5 | indirect |
Dependency advisories 1
This repository publishes no package the index resolves, so its own dependency graph was assessed — 52 packages, which also include development and test pins that never ship: 1 carry known advisories, of which 1 are direct. 3 could not be assessed — no resolved version, an unsupported ecosystem, or beyond the reported package list.
| Package | Version | Relation | Severity | Advisories | Fixed in |
|---|---|---|---|---|---|
| yard | 0.9.43 | direct | moderate | 1 | 0.9.44 |
An advisory means the version recorded in the dependency graph falls inside an advisory’s affected range. Reachability is not analysed, and the graph includes development and test pins — a finding may concern tooling rather than shipped software.
Raw JSON report machine-readable
Feedback
Spotted something off in this report, or have thoughts to share? Wrong measurements, missed tooling, ideas, questions — anything is welcome. Every message is read and gets a response.
Scores are signals, not warranties. They reflect publicly visible practices on GitHub — not a code audit, and not a security guarantee.
Missing data is excluded and weights renormalized, never scored as zero. Methodology is versioned and open: metrics v2.10.0, schema v0.16.0 — full methodology · metrics wiki.
How one result sits in the wider record: aggregate statistics — RubyGems.