AOSSIE-Org / AOSSIE-Org/OrgExplorer

[FEATURE]: Add a Repository Health & Risk Scorecard

未關閉
#222 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視
enhancement
主要語言
JavaScript
星號
34
分支
92
平均合併
8 天 7 小時
30 天內合併 PR
12

描述

### Feature and its Use Cases

Introduce a Repository Health & Risk Scorecard in AOSSIE Org Explorer to provide a clear, actionable overview of the health and maintenance risks of repositories within an organization.

The feature would calculate an Overall Health Score (0–100) for each repository using five weighted pillars:

Bus Factor — identifies single-maintainer or low-maintainer risks.
Governance Compliance — checks repository governance indicators such as license, README, CONTRIBUTING.md, and SECURITY.md.
Activity Freshness — evaluates how recently the repository has been updated.
Issue Responsiveness — measures the proportion of stale open issues and other responsiveness indicators.
PR Resolution Rate — evaluates how effectively pull requests are being resolved/merged.

The Governance section would include a new Health Scorecard tab where repositories can be viewed as individual scorecards.

Each scorecard could display:

Overall health score with a visual radial gauge
Pillar-by-pillar health breakdown
Risk/severity indicators
Automatically generated recommendations
Repository search and pagination
Organization-level summary such as average health and repositories at risk

This would help maintainers and organization administrators quickly identify repositories that need attention instead of having to inspect multiple governance metrics separately.

### Additional Context

The proposed implementation keeps the scoring logic separate from the UI as a pure, testable function and reuses existing repository, contributor, issue, PR, and health-related data wherever possible.

The proposed data flow is:

GitHub API → existing repository/issues/PR data → health scoring engine → repoScorecards → Governance UI

For CONTRIBUTING.md and SECURITY.md detection, the GitHub Contents API could optionally be used behind PAT authentication to avoid excessive unauthenticated API requests.

The scorecards would be sorted from worst to best so that repositories requiring attention are surfaced first.

I would also add unit tests covering each scoring pillar, overall score calculation, and recommendation edge cases.

The main goal is to turn the existing governance information into an actionable repository health overview rather than just a collection of audit metrics.

### Code of Conduct

- [x] I have joined the [Discord server](https://discord.gg/hjUhu33uAn) and will post updates there
- [x] I have searched existing issues to avoid duplicates

貢獻指南

開啟貢獻指南

研究方向

No repository files or entry points are named. Start by locating the existing Governance UI and the repository, contributor, issue, PR, and health-related data it uses, then trace how that data reaches the UI. Done means a separate, testable scoring function, scorecard display and sorting, organization summaries, recommendations, and unit tests for each pillar and edge cases.

由索引模型根據 Issue 內容生成。

評估

技術堆疊
github, javascript
領域
analytics, api, frontend
Issue 類型
功能
難度
5/5
預估耗時
一週以上
活躍度
活躍
描述清晰度
基本清楚
新手友好度
38/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。