[spec-librarian] Specification Audit 2026-09-14: 1 issue found
- Dominant language
- Go
- Stars
- 5.1k
- Forks
- 541
- Avg merge
- 5h 48m
- Merged PRs (30d)
- 773
Description
### π Package Specification Audit Report
**Date**: 2026-09-14
**Total Packages**: 37
**Packages with Specs**: 36
**Coverage**: 97%
---
### Coverage Summary
All 36 packages containing non-test Go source have a `README.md`. One package, `pkg/workflowcontract`, contains only a test file and no README.
| Status | Package | Notes |
|--------|---------|-------|
| β
| 36 packages | Spec present, terminology and import paths consistent |
| β | `workflowcontract` | No `README.md`; package contains only `daily_performance_summary_workflow_contract_test.go` (a contract test with zero exported non-test symbols) |
---
### π¨ Missing Specifications
| Package | Source Files | Exported Symbols | Priority |
|---------|------------|-----------------|----------|
| `workflowcontract` | 1 (test-only) | 0 | Low |
**Recommendation**: `pkg/workflowcontract` currently holds a single `_test.go` file (`TestDailyPerformanceSummaryUsesStableWindowMetrics`) that asserts stable tokens in `.github/workflows/daily-performance-summary.md`. It exposes no public API, so a full spec-extractor README is optional β but a short `README.md` stating the package's purpose (pinning workflow-source contract tokens) would prevent confusion for future contributors browsing `pkg/`. Low priority; add via spec-extractor or a short manual note when convenient.
---
### β οΈ Stale Specifications
None detected. This repository checkout is shallow (single commit), so git-history-based staleness comparison between README and source commits was not possible. As a proxy, README and source file modification timestamps were compared for all 36 documented packages β all showed same-day timestamps with no lag.
---
### π Cross-Package Inconsistencies
None found.
- **Terminology**: Checked stdout/stderr diagnostic conventions across `console`, `logger`, `colorwriter`, `envutil`, `tty`, `testutil`, `cli`, and `workflow` specs β all consistently state diagnostics go to `stderr` and structured/machine-readable output goes to `stdout`.
- **Import paths**: All `github.com/github/gh-aw/pkg/*` references across READMEs resolve to real package directories.
- **Dependency declarations**: Spot-checked `stringutil`, `typeutil`, `errorutil`, `setutil`, and `sliceutil` β declared internal/external dependencies match actual Go imports.
---
### π Quality Scores
Spot-checked packages show healthy, well-structured specs (dedicated sections for API, dependencies, design decisions, usage examples). No completeness, accuracy, or consistency issues were found in the sampled packages.
| Package | Completeness | Accuracy | Consistency | Freshness | Overall |
|---------|-------------|----------|-------------|-----------|---------|
| `console` | β
| β
| β
| β
| β
Good |
| `colorwriter` | β
| β
| β
| β
| β
Good |
| `logger` | β
| β
| β
| β
| β
Good |
| `stringutil` | β
| β
| β
| β
| β
Good |
| `errorutil` | β
| β
| β
| β
| β
Good |
| `cli` | β
| β
| β
| β
| β
Good |
---
### Action Items
- [ ] Optionally add a minimal `README.md` for `pkg/workflowcontract` describing its role as a workflow-source contract test package (no exported API to document)
- [ ] When opening a fix PR for this issue, include `Closes #` (or `Fixes`/`Resolves`) in the PR description.
---
> π *Next review scheduled for tomorrow. Close this issue once the item above is resolved (or decided as not needed).*
> π *Specification review by [Package Specification Librarian](https://github.com/github/gh-aw/actions/runs/34848897617)* Β· copilot Β· auto Β· 137.6 AIC Β· β 8.17 AIC Β· β 9K Β· [β·](https://github.com/search?q=repo%3Agithub%2Fgh-aw+is%3Aissue+%22gh-aw-workflow-call-id%3A+github%2Fgh-aw%2Fspec-librarian%22&type=issues)
> - [x] expires on Sep 17, 2026, 5:34 AM UTC-08:00
Contributor guide
Research direction
Read pkg/workflowcontract/daily_performance_summary_workflow_contract_test.go and the referenced .github/workflows/daily-performance-summary.md to understand the contract. Add pkg/workflowcontract/README.md describing that the package pins workflow-source contract tokens, then run the named test to confirm it still passes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 76/100