AOSSIE-Org / AOSSIE-Org/Template-Repo

refactor: dynamically compute CATEGORY_TOTALS in checklist-score workflow

Open
#110 0 comments 0 reactions 1 assignee Claimed by @kpj2006 View on GitHub
Dominant language
YAML
Stars
17
Forks
29
Avg merge
3d 13h
Merged PRs (30d)
6

Description

## Summary

The `CATEGORY_TOTALS` map in `.github/workflows/checklist-score.yml` is hardcoded:

```python
CATEGORY_TOTALS = {
"basics": 8,
"change_control": 6,
"reporting": 8,
"quality": 11,
"security": 9,
"analysis": 7,
}
```

These values must be manually updated whenever checklist items are added to or removed from `BestPracticesChecklist.md`, which is error-prone and creates a maintenance burden.

## Proposed Fix

Replace the hardcoded map with a dynamic computation that reads `BestPracticesChecklist.md` at runtime, locates each category heading, and counts all checklist lines (matching `- [ ]`, `- [x]`, `- [X]`, `- [~]`) under each heading. This way, totals are always in sync with the actual checklist content without any manual updates.

## References

- PR: https://github.com/AOSSIE-Org/Template-Repo/pull/108
- Review comment: https://github.com/AOSSIE-Org/Template-Repo/pull/108#discussion_r3005813430

Reported by: @kpj2006

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.