@olegkoval/agent-skills 1.3.0 → 1.3.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.claude-plugin/plugin.json +1 -1
- package/package.json +1 -1
- package/packages/software-development/open-source-publisher/SKILL.md +56 -8
- package/packages/software-development/open-source-publisher/adapters/claude/skills/open-source-publisher/SKILL.md +56 -8
- package/packages/software-development/open-source-publisher/adapters/cursor/skills/open-source-publisher/SKILL.md +56 -8
package/package.json
CHANGED
|
@@ -31,23 +31,31 @@ Use this skill to audit whether an OSS repository is ready to publish, then help
|
|
|
31
31
|
- `Weak`: existing pieces that are present but incomplete, stale, broken, inconsistent, or below the house standard
|
|
32
32
|
- `Missing`: publish-critical pieces that do not exist
|
|
33
33
|
- `Optional`: nice-to-have pieces such as donations or extra badges
|
|
34
|
-
3.
|
|
34
|
+
3. Classify the repository type before recommending changes:
|
|
35
|
+
- `library`, `CLI`, `web app`, `framework`, `docs site`, or `other`
|
|
36
|
+
- use the type to decide whether governance, packaging, or presentation work should come first
|
|
37
|
+
4. Identify maintainer identity and public home information when they affect publishing:
|
|
38
|
+
- Ask for the GitHub handle or org name if the repo will have a public owner/maintainer identity, funding links, release notes, or badges
|
|
39
|
+
- Ask for a canonical website/homepage URL if the project needs a homepage, docs site, or public project URL
|
|
40
|
+
- If `homepage`, `author`, or org metadata already exists and looks current, do not ask again
|
|
41
|
+
5. For existing usable pieces, do not propose replacement by default. Ask a change-oriented question only when useful, for example:
|
|
35
42
|
- "You already have a terminal-style GitHub Pages site. Do you want to keep it or restyle it?"
|
|
36
43
|
- "You already have an icon and social card. Do you want a refresh, or should I leave them as-is?"
|
|
37
44
|
- "You already have release automation. Do you want me to audit only, or also tighten it?"
|
|
38
|
-
|
|
45
|
+
6. Ask only for choices needed to fix missing or weak pieces:
|
|
39
46
|
- If GitHub Pages is missing or weak, ask for style: `oldschool linux`, `terminal`, `modern`, `brutalist`, `glassmorphism`, `y2k`, `hacker`, or custom.
|
|
40
47
|
- If donation wiring is missing, ask whether to enable it: `none`, `GitHub Sponsors`, `Ko-fi`, `Buy Me a Coffee`, `Open Collective`, `Thanks.dev`, or custom URL.
|
|
41
48
|
- If the repo has no clear product essence, ask for a one-sentence positioning statement.
|
|
42
|
-
|
|
49
|
+
7. Implement only approved, missing, or weak work in this order:
|
|
50
|
+
- OSS governance and support files
|
|
43
51
|
- minimal icon
|
|
44
52
|
- social preview image
|
|
45
53
|
- README standard
|
|
46
54
|
- GitHub Pages landing page
|
|
47
55
|
- CI/CD and release audit/fixes
|
|
48
56
|
- donation wiring, if requested
|
|
49
|
-
|
|
50
|
-
|
|
57
|
+
8. Validate locally and with browser/screenshots when possible.
|
|
58
|
+
9. Commit/push only when the user asks or the current task explicitly requires it.
|
|
51
59
|
|
|
52
60
|
## Readiness Audit
|
|
53
61
|
|
|
@@ -57,9 +65,13 @@ Publish-critical checklist:
|
|
|
57
65
|
|
|
58
66
|
- repository identity: clear project name, description, topic/keywords, author, license
|
|
59
67
|
- install path: package manager, release assets, source build, or direct download instructions
|
|
68
|
+
- maintainer identity: GitHub handle or org name when public identity is relevant
|
|
69
|
+
- public home: canonical website/homepage URL when the project needs one
|
|
70
|
+
- if either field does not exist, proceed without it and mark it as absent
|
|
71
|
+
- OSS governance: `LICENSE`, `CONTRIBUTING.md`, `SECURITY.md`, `CODE_OF_CONDUCT.md`, support policy, issue/PR templates, changelog or release notes path
|
|
60
72
|
- README standard: centered shields, icon, title, short description, horizontal rule, essential sections
|
|
61
|
-
- icon: simple SVG mark
|
|
62
|
-
- social image: 1200x630 image with matching metadata,
|
|
73
|
+
- icon: simple SVG mark plus rendered PNG, both committed in predictable paths
|
|
74
|
+
- social image: 1200x630 image with matching metadata, with both SVG source and rendered PNG committed when practical
|
|
63
75
|
- GitHub Pages or docs site: essential install/examples/links/SEO/Open Graph metadata
|
|
64
76
|
- CI quality gates: formatter, linter/static analysis, tests, build/package check
|
|
65
77
|
- release automation: tags/releases/artifacts/package update flow, docs-only changes excluded where needed
|
|
@@ -84,6 +96,8 @@ Missing
|
|
|
84
96
|
|
|
85
97
|
Questions
|
|
86
98
|
- You already have a terminal-style GitHub Pages site. Keep it, or restyle it?
|
|
99
|
+
- What is the GitHub handle or org name for public attribution?
|
|
100
|
+
- What is the canonical website or homepage URL, if any?
|
|
87
101
|
- Donations are not configured. Enable them or leave them off?
|
|
88
102
|
```
|
|
89
103
|
|
|
@@ -97,7 +111,7 @@ Rules:
|
|
|
97
111
|
|
|
98
112
|
## Minimal Icon
|
|
99
113
|
|
|
100
|
-
Create a simple, recognizable SVG logo from the repository's essence. Prefer `logo.svg
|
|
114
|
+
Create a simple, recognizable SVG logo from the repository's essence. Prefer `logo.svg` and also render `logo.png` so the icon can be reused in README assets, release artifacts, and platform-specific previews.
|
|
101
115
|
|
|
102
116
|
Icon rules:
|
|
103
117
|
|
|
@@ -107,6 +121,7 @@ Icon rules:
|
|
|
107
121
|
- Use a simple rounded tile only when it improves favicon readability.
|
|
108
122
|
- Avoid terminal window chrome, decorative dots, random badges, and center glyph clutter unless the project itself is a terminal/window tool.
|
|
109
123
|
- Avoid generic AI tells: glass effects, bokeh/orbs, over-layered gradients, busy shadows, and unrelated emojis.
|
|
124
|
+
- If the repo has a website or homepage, ensure the icon fits that visual system.
|
|
110
125
|
|
|
111
126
|
Good icon pattern for sync/migration tools:
|
|
112
127
|
|
|
@@ -145,6 +160,7 @@ Recommended files:
|
|
|
145
160
|
|
|
146
161
|
- `social-card.svg` as the editable source
|
|
147
162
|
- `social-card.png` rendered from the SVG when render tooling is available
|
|
163
|
+
- keep both files in the repo when practical so the preview can be updated without redrawing the whole asset
|
|
148
164
|
|
|
149
165
|
Social image rules:
|
|
150
166
|
|
|
@@ -154,6 +170,7 @@ Social image rules:
|
|
|
154
170
|
- Match the icon color system.
|
|
155
171
|
- Keep all text inside a safe margin of at least 64px.
|
|
156
172
|
- Use `og:image`, `twitter:image`, width/height meta tags, and meaningful alt text.
|
|
173
|
+
- If the repo has a homepage or canonical website, make the social card and metadata point to that URL consistently.
|
|
157
174
|
|
|
158
175
|
Render checks:
|
|
159
176
|
|
|
@@ -227,6 +244,29 @@ Rules:
|
|
|
227
244
|
- Do not claim coverage, license, support, CI, or releases that are not actually present.
|
|
228
245
|
- Add or fix `LICENSE` before saying MIT/Apache/etc.
|
|
229
246
|
|
|
247
|
+
## OSS Governance
|
|
248
|
+
|
|
249
|
+
Treat governance files as first-class publishing work, not optional paperwork.
|
|
250
|
+
|
|
251
|
+
Check for, or add when appropriate:
|
|
252
|
+
|
|
253
|
+
- `LICENSE`
|
|
254
|
+
- `CONTRIBUTING.md`
|
|
255
|
+
- `SECURITY.md`
|
|
256
|
+
- `CODE_OF_CONDUCT.md`
|
|
257
|
+
- `SUPPORT.md`
|
|
258
|
+
- `.github/ISSUE_TEMPLATE/*`
|
|
259
|
+
- `.github/PULL_REQUEST_TEMPLATE.md`
|
|
260
|
+
- `CHANGELOG.md` or a release notes workflow
|
|
261
|
+
- package metadata for homepage, repository, bugs, and funding links
|
|
262
|
+
|
|
263
|
+
Rules:
|
|
264
|
+
|
|
265
|
+
- For libraries and CLIs, prioritize governance and release path before visual polish.
|
|
266
|
+
- For web apps or product sites, keep the governance checks but allow branding and landing page work to happen earlier when the public-facing experience is the main product.
|
|
267
|
+
- If a repo already has governance docs that are good enough, mark them `Ready` and move on.
|
|
268
|
+
- If the project has no maintainer/support policy, ask whether support should be community-only, maintainer-only, or commercial.
|
|
269
|
+
|
|
230
270
|
## GitHub Pages
|
|
231
271
|
|
|
232
272
|
Create a simple essential GitHub Pages site when the project lacks one or the existing one is weak.
|
|
@@ -272,9 +312,15 @@ Check whether the repository has:
|
|
|
272
312
|
- linter/static analysis
|
|
273
313
|
- tests
|
|
274
314
|
- build/package check
|
|
315
|
+
- dependency review / lockfile integrity checks
|
|
316
|
+
- secret scanning or secret prevention
|
|
317
|
+
- license scanning / OSS compliance scan
|
|
318
|
+
- SBOM or provenance generation where appropriate
|
|
275
319
|
- security scan or OpenSSF Scorecard where appropriate
|
|
276
320
|
- release automation
|
|
277
321
|
- docs/site-only path filters when release runs on `main`
|
|
322
|
+
- docs link checker or markdown validation for repo/docs sites
|
|
323
|
+
- package-specific smoke install / publish dry-run matrix
|
|
278
324
|
|
|
279
325
|
For Go projects, prefer:
|
|
280
326
|
|
|
@@ -302,6 +348,8 @@ Release automation rules:
|
|
|
302
348
|
- Make Homebrew/package formulas update from real release artifacts and checksums.
|
|
303
349
|
- Use least-privilege secrets and document required secret names.
|
|
304
350
|
- If automation pushes tags, guard against rerun/version reuse.
|
|
351
|
+
- Prefer signed or attestable releases where the ecosystem supports it.
|
|
352
|
+
- Prefer release notes generation from tags or merged PRs instead of hand-written release bodies when the repo is release-heavy.
|
|
305
353
|
|
|
306
354
|
## Donations
|
|
307
355
|
|
|
@@ -33,23 +33,31 @@ Use this skill to audit whether an OSS repository is ready to publish, then help
|
|
|
33
33
|
- `Weak`: existing pieces that are present but incomplete, stale, broken, inconsistent, or below the house standard
|
|
34
34
|
- `Missing`: publish-critical pieces that do not exist
|
|
35
35
|
- `Optional`: nice-to-have pieces such as donations or extra badges
|
|
36
|
-
3.
|
|
36
|
+
3. Classify the repository type before recommending changes:
|
|
37
|
+
- `library`, `CLI`, `web app`, `framework`, `docs site`, or `other`
|
|
38
|
+
- use the type to decide whether governance, packaging, or presentation work should come first
|
|
39
|
+
4. Identify maintainer identity and public home information when they affect publishing:
|
|
40
|
+
- Ask for the GitHub handle or org name if the repo will have a public owner/maintainer identity, funding links, release notes, or badges
|
|
41
|
+
- Ask for a canonical website/homepage URL if the project needs a homepage, docs site, or public project URL
|
|
42
|
+
- If `homepage`, `author`, or org metadata already exists and looks current, do not ask again
|
|
43
|
+
5. For existing usable pieces, do not propose replacement by default. Ask a change-oriented question only when useful, for example:
|
|
37
44
|
- "You already have a terminal-style GitHub Pages site. Do you want to keep it or restyle it?"
|
|
38
45
|
- "You already have an icon and social card. Do you want a refresh, or should I leave them as-is?"
|
|
39
46
|
- "You already have release automation. Do you want me to audit only, or also tighten it?"
|
|
40
|
-
|
|
47
|
+
6. Ask only for choices needed to fix missing or weak pieces:
|
|
41
48
|
- If GitHub Pages is missing or weak, ask for style: `oldschool linux`, `terminal`, `modern`, `brutalist`, `glassmorphism`, `y2k`, `hacker`, or custom.
|
|
42
49
|
- If donation wiring is missing, ask whether to enable it: `none`, `GitHub Sponsors`, `Ko-fi`, `Buy Me a Coffee`, `Open Collective`, `Thanks.dev`, or custom URL.
|
|
43
50
|
- If the repo has no clear product essence, ask for a one-sentence positioning statement.
|
|
44
|
-
|
|
51
|
+
7. Implement only approved, missing, or weak work in this order:
|
|
52
|
+
- OSS governance and support files
|
|
45
53
|
- minimal icon
|
|
46
54
|
- social preview image
|
|
47
55
|
- README standard
|
|
48
56
|
- GitHub Pages landing page
|
|
49
57
|
- CI/CD and release audit/fixes
|
|
50
58
|
- donation wiring, if requested
|
|
51
|
-
|
|
52
|
-
|
|
59
|
+
8. Validate locally and with browser/screenshots when possible.
|
|
60
|
+
9. Commit/push only when the user asks or the current task explicitly requires it.
|
|
53
61
|
|
|
54
62
|
## Readiness Audit
|
|
55
63
|
|
|
@@ -59,9 +67,13 @@ Publish-critical checklist:
|
|
|
59
67
|
|
|
60
68
|
- repository identity: clear project name, description, topic/keywords, author, license
|
|
61
69
|
- install path: package manager, release assets, source build, or direct download instructions
|
|
70
|
+
- maintainer identity: GitHub handle or org name when public identity is relevant
|
|
71
|
+
- public home: canonical website/homepage URL when the project needs one
|
|
72
|
+
- if either field does not exist, proceed without it and mark it as absent
|
|
73
|
+
- OSS governance: `LICENSE`, `CONTRIBUTING.md`, `SECURITY.md`, `CODE_OF_CONDUCT.md`, support policy, issue/PR templates, changelog or release notes path
|
|
62
74
|
- README standard: centered shields, icon, title, short description, horizontal rule, essential sections
|
|
63
|
-
- icon: simple SVG mark
|
|
64
|
-
- social image: 1200x630 image with matching metadata,
|
|
75
|
+
- icon: simple SVG mark plus rendered PNG, both committed in predictable paths
|
|
76
|
+
- social image: 1200x630 image with matching metadata, with both SVG source and rendered PNG committed when practical
|
|
65
77
|
- GitHub Pages or docs site: essential install/examples/links/SEO/Open Graph metadata
|
|
66
78
|
- CI quality gates: formatter, linter/static analysis, tests, build/package check
|
|
67
79
|
- release automation: tags/releases/artifacts/package update flow, docs-only changes excluded where needed
|
|
@@ -86,6 +98,8 @@ Missing
|
|
|
86
98
|
|
|
87
99
|
Questions
|
|
88
100
|
- You already have a terminal-style GitHub Pages site. Keep it, or restyle it?
|
|
101
|
+
- What is the GitHub handle or org name for public attribution?
|
|
102
|
+
- What is the canonical website or homepage URL, if any?
|
|
89
103
|
- Donations are not configured. Enable them or leave them off?
|
|
90
104
|
```
|
|
91
105
|
|
|
@@ -99,7 +113,7 @@ Rules:
|
|
|
99
113
|
|
|
100
114
|
## Minimal Icon
|
|
101
115
|
|
|
102
|
-
Create a simple, recognizable SVG logo from the repository's essence. Prefer `logo.svg
|
|
116
|
+
Create a simple, recognizable SVG logo from the repository's essence. Prefer `logo.svg` and also render `logo.png` so the icon can be reused in README assets, release artifacts, and platform-specific previews.
|
|
103
117
|
|
|
104
118
|
Icon rules:
|
|
105
119
|
|
|
@@ -109,6 +123,7 @@ Icon rules:
|
|
|
109
123
|
- Use a simple rounded tile only when it improves favicon readability.
|
|
110
124
|
- Avoid terminal window chrome, decorative dots, random badges, and center glyph clutter unless the project itself is a terminal/window tool.
|
|
111
125
|
- Avoid generic AI tells: glass effects, bokeh/orbs, over-layered gradients, busy shadows, and unrelated emojis.
|
|
126
|
+
- If the repo has a website or homepage, ensure the icon fits that visual system.
|
|
112
127
|
|
|
113
128
|
Good icon pattern for sync/migration tools:
|
|
114
129
|
|
|
@@ -147,6 +162,7 @@ Recommended files:
|
|
|
147
162
|
|
|
148
163
|
- `social-card.svg` as the editable source
|
|
149
164
|
- `social-card.png` rendered from the SVG when render tooling is available
|
|
165
|
+
- keep both files in the repo when practical so the preview can be updated without redrawing the whole asset
|
|
150
166
|
|
|
151
167
|
Social image rules:
|
|
152
168
|
|
|
@@ -156,6 +172,7 @@ Social image rules:
|
|
|
156
172
|
- Match the icon color system.
|
|
157
173
|
- Keep all text inside a safe margin of at least 64px.
|
|
158
174
|
- Use `og:image`, `twitter:image`, width/height meta tags, and meaningful alt text.
|
|
175
|
+
- If the repo has a homepage or canonical website, make the social card and metadata point to that URL consistently.
|
|
159
176
|
|
|
160
177
|
Render checks:
|
|
161
178
|
|
|
@@ -229,6 +246,29 @@ Rules:
|
|
|
229
246
|
- Do not claim coverage, license, support, CI, or releases that are not actually present.
|
|
230
247
|
- Add or fix `LICENSE` before saying MIT/Apache/etc.
|
|
231
248
|
|
|
249
|
+
## OSS Governance
|
|
250
|
+
|
|
251
|
+
Treat governance files as first-class publishing work, not optional paperwork.
|
|
252
|
+
|
|
253
|
+
Check for, or add when appropriate:
|
|
254
|
+
|
|
255
|
+
- `LICENSE`
|
|
256
|
+
- `CONTRIBUTING.md`
|
|
257
|
+
- `SECURITY.md`
|
|
258
|
+
- `CODE_OF_CONDUCT.md`
|
|
259
|
+
- `SUPPORT.md`
|
|
260
|
+
- `.github/ISSUE_TEMPLATE/*`
|
|
261
|
+
- `.github/PULL_REQUEST_TEMPLATE.md`
|
|
262
|
+
- `CHANGELOG.md` or a release notes workflow
|
|
263
|
+
- package metadata for homepage, repository, bugs, and funding links
|
|
264
|
+
|
|
265
|
+
Rules:
|
|
266
|
+
|
|
267
|
+
- For libraries and CLIs, prioritize governance and release path before visual polish.
|
|
268
|
+
- For web apps or product sites, keep the governance checks but allow branding and landing page work to happen earlier when the public-facing experience is the main product.
|
|
269
|
+
- If a repo already has governance docs that are good enough, mark them `Ready` and move on.
|
|
270
|
+
- If the project has no maintainer/support policy, ask whether support should be community-only, maintainer-only, or commercial.
|
|
271
|
+
|
|
232
272
|
## GitHub Pages
|
|
233
273
|
|
|
234
274
|
Create a simple essential GitHub Pages site when the project lacks one or the existing one is weak.
|
|
@@ -274,9 +314,15 @@ Check whether the repository has:
|
|
|
274
314
|
- linter/static analysis
|
|
275
315
|
- tests
|
|
276
316
|
- build/package check
|
|
317
|
+
- dependency review / lockfile integrity checks
|
|
318
|
+
- secret scanning or secret prevention
|
|
319
|
+
- license scanning / OSS compliance scan
|
|
320
|
+
- SBOM or provenance generation where appropriate
|
|
277
321
|
- security scan or OpenSSF Scorecard where appropriate
|
|
278
322
|
- release automation
|
|
279
323
|
- docs/site-only path filters when release runs on `main`
|
|
324
|
+
- docs link checker or markdown validation for repo/docs sites
|
|
325
|
+
- package-specific smoke install / publish dry-run matrix
|
|
280
326
|
|
|
281
327
|
For Go projects, prefer:
|
|
282
328
|
|
|
@@ -304,6 +350,8 @@ Release automation rules:
|
|
|
304
350
|
- Make Homebrew/package formulas update from real release artifacts and checksums.
|
|
305
351
|
- Use least-privilege secrets and document required secret names.
|
|
306
352
|
- If automation pushes tags, guard against rerun/version reuse.
|
|
353
|
+
- Prefer signed or attestable releases where the ecosystem supports it.
|
|
354
|
+
- Prefer release notes generation from tags or merged PRs instead of hand-written release bodies when the repo is release-heavy.
|
|
307
355
|
|
|
308
356
|
## Donations
|
|
309
357
|
|
|
@@ -33,23 +33,31 @@ Use this skill to audit whether an OSS repository is ready to publish, then help
|
|
|
33
33
|
- `Weak`: existing pieces that are present but incomplete, stale, broken, inconsistent, or below the house standard
|
|
34
34
|
- `Missing`: publish-critical pieces that do not exist
|
|
35
35
|
- `Optional`: nice-to-have pieces such as donations or extra badges
|
|
36
|
-
3.
|
|
36
|
+
3. Classify the repository type before recommending changes:
|
|
37
|
+
- `library`, `CLI`, `web app`, `framework`, `docs site`, or `other`
|
|
38
|
+
- use the type to decide whether governance, packaging, or presentation work should come first
|
|
39
|
+
4. Identify maintainer identity and public home information when they affect publishing:
|
|
40
|
+
- Ask for the GitHub handle or org name if the repo will have a public owner/maintainer identity, funding links, release notes, or badges
|
|
41
|
+
- Ask for a canonical website/homepage URL if the project needs a homepage, docs site, or public project URL
|
|
42
|
+
- If `homepage`, `author`, or org metadata already exists and looks current, do not ask again
|
|
43
|
+
5. For existing usable pieces, do not propose replacement by default. Ask a change-oriented question only when useful, for example:
|
|
37
44
|
- "You already have a terminal-style GitHub Pages site. Do you want to keep it or restyle it?"
|
|
38
45
|
- "You already have an icon and social card. Do you want a refresh, or should I leave them as-is?"
|
|
39
46
|
- "You already have release automation. Do you want me to audit only, or also tighten it?"
|
|
40
|
-
|
|
47
|
+
6. Ask only for choices needed to fix missing or weak pieces:
|
|
41
48
|
- If GitHub Pages is missing or weak, ask for style: `oldschool linux`, `terminal`, `modern`, `brutalist`, `glassmorphism`, `y2k`, `hacker`, or custom.
|
|
42
49
|
- If donation wiring is missing, ask whether to enable it: `none`, `GitHub Sponsors`, `Ko-fi`, `Buy Me a Coffee`, `Open Collective`, `Thanks.dev`, or custom URL.
|
|
43
50
|
- If the repo has no clear product essence, ask for a one-sentence positioning statement.
|
|
44
|
-
|
|
51
|
+
7. Implement only approved, missing, or weak work in this order:
|
|
52
|
+
- OSS governance and support files
|
|
45
53
|
- minimal icon
|
|
46
54
|
- social preview image
|
|
47
55
|
- README standard
|
|
48
56
|
- GitHub Pages landing page
|
|
49
57
|
- CI/CD and release audit/fixes
|
|
50
58
|
- donation wiring, if requested
|
|
51
|
-
|
|
52
|
-
|
|
59
|
+
8. Validate locally and with browser/screenshots when possible.
|
|
60
|
+
9. Commit/push only when the user asks or the current task explicitly requires it.
|
|
53
61
|
|
|
54
62
|
## Readiness Audit
|
|
55
63
|
|
|
@@ -59,9 +67,13 @@ Publish-critical checklist:
|
|
|
59
67
|
|
|
60
68
|
- repository identity: clear project name, description, topic/keywords, author, license
|
|
61
69
|
- install path: package manager, release assets, source build, or direct download instructions
|
|
70
|
+
- maintainer identity: GitHub handle or org name when public identity is relevant
|
|
71
|
+
- public home: canonical website/homepage URL when the project needs one
|
|
72
|
+
- if either field does not exist, proceed without it and mark it as absent
|
|
73
|
+
- OSS governance: `LICENSE`, `CONTRIBUTING.md`, `SECURITY.md`, `CODE_OF_CONDUCT.md`, support policy, issue/PR templates, changelog or release notes path
|
|
62
74
|
- README standard: centered shields, icon, title, short description, horizontal rule, essential sections
|
|
63
|
-
- icon: simple SVG mark
|
|
64
|
-
- social image: 1200x630 image with matching metadata,
|
|
75
|
+
- icon: simple SVG mark plus rendered PNG, both committed in predictable paths
|
|
76
|
+
- social image: 1200x630 image with matching metadata, with both SVG source and rendered PNG committed when practical
|
|
65
77
|
- GitHub Pages or docs site: essential install/examples/links/SEO/Open Graph metadata
|
|
66
78
|
- CI quality gates: formatter, linter/static analysis, tests, build/package check
|
|
67
79
|
- release automation: tags/releases/artifacts/package update flow, docs-only changes excluded where needed
|
|
@@ -86,6 +98,8 @@ Missing
|
|
|
86
98
|
|
|
87
99
|
Questions
|
|
88
100
|
- You already have a terminal-style GitHub Pages site. Keep it, or restyle it?
|
|
101
|
+
- What is the GitHub handle or org name for public attribution?
|
|
102
|
+
- What is the canonical website or homepage URL, if any?
|
|
89
103
|
- Donations are not configured. Enable them or leave them off?
|
|
90
104
|
```
|
|
91
105
|
|
|
@@ -99,7 +113,7 @@ Rules:
|
|
|
99
113
|
|
|
100
114
|
## Minimal Icon
|
|
101
115
|
|
|
102
|
-
Create a simple, recognizable SVG logo from the repository's essence. Prefer `logo.svg
|
|
116
|
+
Create a simple, recognizable SVG logo from the repository's essence. Prefer `logo.svg` and also render `logo.png` so the icon can be reused in README assets, release artifacts, and platform-specific previews.
|
|
103
117
|
|
|
104
118
|
Icon rules:
|
|
105
119
|
|
|
@@ -109,6 +123,7 @@ Icon rules:
|
|
|
109
123
|
- Use a simple rounded tile only when it improves favicon readability.
|
|
110
124
|
- Avoid terminal window chrome, decorative dots, random badges, and center glyph clutter unless the project itself is a terminal/window tool.
|
|
111
125
|
- Avoid generic AI tells: glass effects, bokeh/orbs, over-layered gradients, busy shadows, and unrelated emojis.
|
|
126
|
+
- If the repo has a website or homepage, ensure the icon fits that visual system.
|
|
112
127
|
|
|
113
128
|
Good icon pattern for sync/migration tools:
|
|
114
129
|
|
|
@@ -147,6 +162,7 @@ Recommended files:
|
|
|
147
162
|
|
|
148
163
|
- `social-card.svg` as the editable source
|
|
149
164
|
- `social-card.png` rendered from the SVG when render tooling is available
|
|
165
|
+
- keep both files in the repo when practical so the preview can be updated without redrawing the whole asset
|
|
150
166
|
|
|
151
167
|
Social image rules:
|
|
152
168
|
|
|
@@ -156,6 +172,7 @@ Social image rules:
|
|
|
156
172
|
- Match the icon color system.
|
|
157
173
|
- Keep all text inside a safe margin of at least 64px.
|
|
158
174
|
- Use `og:image`, `twitter:image`, width/height meta tags, and meaningful alt text.
|
|
175
|
+
- If the repo has a homepage or canonical website, make the social card and metadata point to that URL consistently.
|
|
159
176
|
|
|
160
177
|
Render checks:
|
|
161
178
|
|
|
@@ -229,6 +246,29 @@ Rules:
|
|
|
229
246
|
- Do not claim coverage, license, support, CI, or releases that are not actually present.
|
|
230
247
|
- Add or fix `LICENSE` before saying MIT/Apache/etc.
|
|
231
248
|
|
|
249
|
+
## OSS Governance
|
|
250
|
+
|
|
251
|
+
Treat governance files as first-class publishing work, not optional paperwork.
|
|
252
|
+
|
|
253
|
+
Check for, or add when appropriate:
|
|
254
|
+
|
|
255
|
+
- `LICENSE`
|
|
256
|
+
- `CONTRIBUTING.md`
|
|
257
|
+
- `SECURITY.md`
|
|
258
|
+
- `CODE_OF_CONDUCT.md`
|
|
259
|
+
- `SUPPORT.md`
|
|
260
|
+
- `.github/ISSUE_TEMPLATE/*`
|
|
261
|
+
- `.github/PULL_REQUEST_TEMPLATE.md`
|
|
262
|
+
- `CHANGELOG.md` or a release notes workflow
|
|
263
|
+
- package metadata for homepage, repository, bugs, and funding links
|
|
264
|
+
|
|
265
|
+
Rules:
|
|
266
|
+
|
|
267
|
+
- For libraries and CLIs, prioritize governance and release path before visual polish.
|
|
268
|
+
- For web apps or product sites, keep the governance checks but allow branding and landing page work to happen earlier when the public-facing experience is the main product.
|
|
269
|
+
- If a repo already has governance docs that are good enough, mark them `Ready` and move on.
|
|
270
|
+
- If the project has no maintainer/support policy, ask whether support should be community-only, maintainer-only, or commercial.
|
|
271
|
+
|
|
232
272
|
## GitHub Pages
|
|
233
273
|
|
|
234
274
|
Create a simple essential GitHub Pages site when the project lacks one or the existing one is weak.
|
|
@@ -274,9 +314,15 @@ Check whether the repository has:
|
|
|
274
314
|
- linter/static analysis
|
|
275
315
|
- tests
|
|
276
316
|
- build/package check
|
|
317
|
+
- dependency review / lockfile integrity checks
|
|
318
|
+
- secret scanning or secret prevention
|
|
319
|
+
- license scanning / OSS compliance scan
|
|
320
|
+
- SBOM or provenance generation where appropriate
|
|
277
321
|
- security scan or OpenSSF Scorecard where appropriate
|
|
278
322
|
- release automation
|
|
279
323
|
- docs/site-only path filters when release runs on `main`
|
|
324
|
+
- docs link checker or markdown validation for repo/docs sites
|
|
325
|
+
- package-specific smoke install / publish dry-run matrix
|
|
280
326
|
|
|
281
327
|
For Go projects, prefer:
|
|
282
328
|
|
|
@@ -304,6 +350,8 @@ Release automation rules:
|
|
|
304
350
|
- Make Homebrew/package formulas update from real release artifacts and checksums.
|
|
305
351
|
- Use least-privilege secrets and document required secret names.
|
|
306
352
|
- If automation pushes tags, guard against rerun/version reuse.
|
|
353
|
+
- Prefer signed or attestable releases where the ecosystem supports it.
|
|
354
|
+
- Prefer release notes generation from tags or merged PRs instead of hand-written release bodies when the repo is release-heavy.
|
|
307
355
|
|
|
308
356
|
## Donations
|
|
309
357
|
|