Skip to content

Commit 04a8ada

Browse files
MariusStorhaugMariusStorhaug
committed
📖 [Docs]: Add README standardization reports and GitHub Actions standards
1 parent 00523d9 commit 04a8ada

15 files changed

Lines changed: 1745 additions & 9 deletions

‎readme-eval-report.md‎

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
# README rollout — evaluation against the new standard (2026-07-12)
2+
3+
> Snapshot of the **current head** of each of the 55 open landing-page PRs versus the
4+
> standard as revised in PR #61 (`Repository-Defaults.md` + `Module-Types.md` + version policy).
5+
> All 55 PRs are **OPEN** and every head README was re-fetched and confirmed current.
6+
> Nothing has been applied — this is a conformance snapshot. Detailed per-repo fix actions
7+
> live in `readme-rollout-review.md`.
8+
9+
## Summary
10+
11+
| Verdict | Count | Meaning |
12+
| --- | --- | --- |
13+
| PASS | 0 | Fully conforms to the new standard. |
14+
| MINOR | 20 | Genuine placeholder, correct shape; only a boilerplate `## Contributing` to remove. |
15+
| NEEDS CHANGES | 34 | Implemented module missing `## Usage` and/or other fixes. |
16+
| SKIP | 1 | Inherited/unmaintained (AzureDevOps). |
17+
18+
**Headline: 0/55 conform yet** — expected, since the PRs pre-date the standard and have not been applied.
19+
20+
### Violation tallies
21+
22+
- **Missing `## Usage` showcase:** 34 (every implemented module).
23+
- **Has `## Contributing` (remove; ship `CONTRIBUTING.md`):** 55 (all 55).
24+
- **Has `## Capabilities`:** 0 — good, none; `## Usage` just needs adding, no rename on the PRs.
25+
- **Uses `Install-Module` (-> `Install-PSResource`):** 5 — Admin, AzureDevOps, DynamicParams, ElvUI, PSSemVer.
26+
- **Ships `<CommandName>` placeholder:** 17 — Ast, AzureDevOps, base64, Dns, Fonts, Json, Jwt, Lua, Markdown, MemoryMappedFile, Net, Object, PowerShellGallery, PublicIP, Retry, Uri, Utilities.
27+
- **Unfilled `{{ NAME }}`/`{{ DESCRIPTION }}`:** 0 — good, all filled.
28+
- **Wrongly marked placeholder (real commands):** Hcl, Toml.
29+
- **Needs over-deleted content RESTORED:** 23 (see review log for specifics).
30+
31+
## NEEDS CHANGES (34)
32+
33+
| Repo | PR | Class | Findings |
34+
| --- | --- | --- | --- |
35+
| Admin | #41 | IMPLEMENTED | missing ## Usage showcase; has ## Contributing (remove; ship CONTRIBUTING.md); uses Install-Module (-> Install-PSResource); no Install-PSResource; RESTORE over-deleted unique content (see review log) |
36+
| Ast | #43 | IMPLEMENTED | missing ## Usage showcase; has ## Contributing (remove; ship CONTRIBUTING.md); ships <CommandName> placeholder (-> real command); RESTORE over-deleted unique content (see review log) |
37+
| Base64 | #23 | IMPLEMENTED | missing ## Usage showcase; has ## Contributing (remove; ship CONTRIBUTING.md); ships <CommandName> placeholder (-> real command); RESTORE over-deleted unique content (see review log) |
38+
| CasingStyle | #20 | IMPLEMENTED | missing ## Usage showcase; has ## Contributing (remove; ship CONTRIBUTING.md); RESTORE over-deleted unique content (see review log) |
39+
| Context | #120 | IMPLEMENTED | missing ## Usage showcase; has ## Contributing (remove; ship CONTRIBUTING.md); RESTORE over-deleted unique content (see review log) |
40+
| Dns | #20 | IMPLEMENTED | missing ## Usage showcase; has ## Contributing (remove; ship CONTRIBUTING.md); ships <CommandName> placeholder (-> real command) |
41+
| DynamicParams | #35 | IMPLEMENTED | missing ## Usage showcase; has ## Contributing (remove; ship CONTRIBUTING.md); uses Install-Module (-> Install-PSResource); RESTORE over-deleted unique content (see review log) |
42+
| ElvUI | #8 | IMPLEMENTED | missing ## Usage showcase; has ## Contributing (remove; ship CONTRIBUTING.md); uses Install-Module (-> Install-PSResource); RESTORE over-deleted unique content (see review log) |
43+
| Fonts | #63 | IMPLEMENTED | missing ## Usage showcase; has ## Contributing (remove; ship CONTRIBUTING.md); ships <CommandName> placeholder (-> real command); RESTORE over-deleted unique content (see review log) |
44+
| GoogleFonts | #238 | IMPLEMENTED | missing ## Usage showcase; has ## Contributing (remove; ship CONTRIBUTING.md); RESTORE over-deleted unique content (see review log) |
45+
| Guid | #16 | IMPLEMENTED | missing ## Usage showcase; has ## Contributing (remove; ship CONTRIBUTING.md); RESTORE over-deleted unique content (see review log) |
46+
| Hashtable | #30 | IMPLEMENTED | missing ## Usage showcase; has ## Contributing (remove; ship CONTRIBUTING.md); RESTORE over-deleted unique content (see review log) |
47+
| Hcl | #7 | IMPLEMENTED (misclassified placeholder) | wrongly marked placeholder -> make a landing page; missing ## Usage; has ## Contributing (remove; ship CONTRIBUTING.md) |
48+
| Json | #22 | IMPLEMENTED | missing ## Usage showcase; has ## Contributing (remove; ship CONTRIBUTING.md); ships <CommandName> placeholder (-> real command) |
49+
| Jwt | #32 | IMPLEMENTED | missing ## Usage showcase; has ## Contributing (remove; ship CONTRIBUTING.md); ships <CommandName> placeholder (-> real command); RESTORE over-deleted unique content (see review log) |
50+
| Lua | #13 | IMPLEMENTED | missing ## Usage showcase; has ## Contributing (remove; ship CONTRIBUTING.md); ships <CommandName> placeholder (-> real command); RESTORE over-deleted unique content (see review log) |
51+
| Markdown | #28 | IMPLEMENTED | missing ## Usage showcase; has ## Contributing (remove; ship CONTRIBUTING.md); ships <CommandName> placeholder (-> real command); RESTORE over-deleted unique content (see review log) |
52+
| MemoryMappedFile | #14 | IMPLEMENTED | missing ## Usage showcase; has ## Contributing (remove; ship CONTRIBUTING.md); ships <CommandName> placeholder (-> real command) |
53+
| Net | #16 | IMPLEMENTED | missing ## Usage showcase; has ## Contributing (remove; ship CONTRIBUTING.md); ships <CommandName> placeholder (-> real command) |
54+
| Object | #15 | IMPLEMENTED | missing ## Usage showcase; has ## Contributing (remove; ship CONTRIBUTING.md); ships <CommandName> placeholder (-> real command) |
55+
| Path | #38 | IMPLEMENTED | missing ## Usage showcase; has ## Contributing (remove; ship CONTRIBUTING.md); RESTORE over-deleted unique content (see review log) |
56+
| PowerShellGallery | #31 | IMPLEMENTED | missing ## Usage showcase; has ## Contributing (remove; ship CONTRIBUTING.md); ships <CommandName> placeholder (-> real command) |
57+
| PSCredential | #21 | IMPLEMENTED | missing ## Usage showcase; has ## Contributing (remove; ship CONTRIBUTING.md); RESTORE over-deleted unique content (see review log) |
58+
| PSCustomObject | #18 | IMPLEMENTED | missing ## Usage showcase; has ## Contributing (remove; ship CONTRIBUTING.md); RESTORE over-deleted unique content (see review log) |
59+
| PSSemVer | #44 | IMPLEMENTED | missing ## Usage showcase; has ## Contributing (remove; ship CONTRIBUTING.md); uses Install-Module (-> Install-PSResource); RESTORE over-deleted unique content (see review log) |
60+
| PublicIP | #33 | IMPLEMENTED | missing ## Usage showcase; has ## Contributing (remove; ship CONTRIBUTING.md); ships <CommandName> placeholder (-> real command); RESTORE over-deleted unique content (see review log) |
61+
| Retry | #19 | IMPLEMENTED | missing ## Usage showcase; has ## Contributing (remove; ship CONTRIBUTING.md); ships <CommandName> placeholder (-> real command) |
62+
| Sodium | #66 | IMPLEMENTED | missing ## Usage showcase; has ## Contributing (remove; ship CONTRIBUTING.md); RESTORE over-deleted unique content (see review log) |
63+
| TimeSpan | #24 | IMPLEMENTED | missing ## Usage showcase; has ## Contributing (remove; ship CONTRIBUTING.md); RESTORE over-deleted unique content (see review log) |
64+
| Tls | #16 | IMPLEMENTED | missing ## Usage showcase; has ## Contributing (remove; ship CONTRIBUTING.md); RESTORE over-deleted unique content (see review log) |
65+
| Toml | #10 | IMPLEMENTED (misclassified placeholder) | wrongly marked placeholder -> make a landing page; missing ## Usage; has ## Contributing (remove; ship CONTRIBUTING.md) |
66+
| Uri | #17 | IMPLEMENTED | missing ## Usage showcase; has ## Contributing (remove; ship CONTRIBUTING.md); ships <CommandName> placeholder (-> real command); RESTORE over-deleted unique content (see review log) |
67+
| Utilities | #103 | IMPLEMENTED | missing ## Usage showcase; has ## Contributing (remove; ship CONTRIBUTING.md); ships <CommandName> placeholder (-> real command) |
68+
| WoW | #34 | IMPLEMENTED | missing ## Usage showcase; has ## Contributing (remove; ship CONTRIBUTING.md) |
69+
70+
## MINOR — placeholders (only drop `## Contributing`) (20)
71+
72+
| Repo | PR | Class | Findings |
73+
| --- | --- | --- | --- |
74+
| Anthropic | #12 | PLACEHOLDER (scaffold-only) | has ## Contributing (remove; not in placeholder shape) |
75+
| Bluesky | #15 | PLACEHOLDER (scaffold-only) | has ## Contributing (remove; not in placeholder shape) |
76+
| Claude | #11 | PLACEHOLDER (scaffold-only) | has ## Contributing (remove; not in placeholder shape) |
77+
| Context7 | #13 | PLACEHOLDER (scaffold-only) | has ## Contributing (remove; not in placeholder shape) |
78+
| CurseForge | #36 | PLACEHOLDER (scaffold-only) | has ## Contributing (remove; not in placeholder shape) |
79+
| DateTime | #15 | PLACEHOLDER (scaffold-only) | has ## Contributing (remove; not in placeholder shape) |
80+
| DeepSeek | #15 | PLACEHOLDER (scaffold-only) | has ## Contributing (remove; not in placeholder shape) |
81+
| Discord | #13 | PLACEHOLDER (scaffold-only) | has ## Contributing (remove; not in placeholder shape) |
82+
| Domeneshop | #12 | PLACEHOLDER (scaffold-only) | has ## Contributing (remove; not in placeholder shape) |
83+
| Gemini | #11 | PLACEHOLDER (scaffold-only) | has ## Contributing (remove; not in placeholder shape) |
84+
| GraphQL | #21 | PLACEHOLDER (scaffold-only) | has ## Contributing (remove; not in placeholder shape) |
85+
| GZip | #17 | PLACEHOLDER (scaffold-only) | has ## Contributing (remove; not in placeholder shape) |
86+
| IPv4 | #24 | PLACEHOLDER (scaffold-only) | has ## Contributing (remove; not in placeholder shape) |
87+
| IPv6 | #13 | PLACEHOLDER (scaffold-only) | has ## Contributing (remove; not in placeholder shape) |
88+
| LinkedIn | #18 | PLACEHOLDER (scaffold-only) | has ## Contributing (remove; not in placeholder shape) |
89+
| OpenAI | #22 | PLACEHOLDER (scaffold-only) | has ## Contributing (remove; not in placeholder shape) |
90+
| PowerShellDataFile | #18 | PLACEHOLDER (scaffold-only) | has ## Contributing (remove; not in placeholder shape) |
91+
| Telemetry | #18 | PLACEHOLDER (scaffold-only) | has ## Contributing (remove; not in placeholder shape) |
92+
| Twitch | #14 | PLACEHOLDER (scaffold-only) | has ## Contributing (remove; not in placeholder shape) |
93+
| Yaml | #34 | PLACEHOLDER (scaffold-only) | has ## Contributing (remove; not in placeholder shape) |
94+
95+
## SKIP (1)
96+
97+
| Repo | PR | Class | Findings |
98+
| --- | --- | --- | --- |
99+
| AzureDevOps | #2 | SKIP | — |
100+
101+
## Notes
102+
103+
- **Good news:** no PR uses `## Capabilities` and none have unfilled `{{ }}` tokens, so the
104+
per-PR work is *adding* `## Usage` + restoring content, not undoing a bad rename.
105+
- **`CONTRIBUTING.md` / agent files (`AGENTS.md`, `CLAUDE.md`, `.github/copilot-instructions.md`)**
106+
are a **Distributor** rollout (mandatory file sets), not part of these 55 README PRs — the PRs
107+
only need the `## Contributing` *section* removed from the README.
108+
- **Hcl #7 and Toml #10** are marked as placeholders but export real commands — convert to landing pages.
109+
- **AzureDevOps #2** and **jira-archive** are skipped (inherited/unmaintained).
110+
- Detailed restore/Usage proposals per repo: see `readme-rollout-review.md`.
111+

0 commit comments

Comments
 (0)