-
Notifications
You must be signed in to change notification settings - Fork 0
feat: v2.3.0 — ecosystem refresh, Agent Skills compliance, FAQ rename #50
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
7e23241
f436c18
ffca40f
488754a
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -114,7 +114,7 @@ After fetching, use Edit tool to replace these placeholders: | |
| - `[INSERT CONTACT METHOD]` — project contact email or reporting URL | ||
| - Verify the "Enforcement" section matches the project's governance structure | ||
|
|
||
| **Why v3.0:** Clearer language, less US-centric phrasing, "Addressing and Repairing Harm" section aligned with restorative justice principles. Always use v3.0 for new projects. | ||
| **Why v3.0:** Clearer language, less US-centric phrasing, "Addressing and Repairing Harm" section aligned with restorative justice principles. Always use v3.0 for new projects. **High-profile validation:** Django completed migration to v3.0 on 2026-04-15 — a strong credibility signal for the v3.0 default. | ||
|
|
||
| **Fallback:** If the URL is unreachable, direct the user to https://www.contributor-covenant.org/version/3/0/code_of_conduct/ and ask them to download manually. | ||
|
|
||
|
|
@@ -154,6 +154,8 @@ After fetching or creating the starter file, use Edit tool to customise in small | |
|
|
||
| ## .github/ISSUE_TEMPLATE/bug_report.yml | ||
|
|
||
| > **GitHub Issue Forms updates (2026):** As of 2026-03-05, Issue Forms support an `attachments` field for required logs/screenshots/crash reports, and template files are sorted alphabetically in the picker — name files with leading numbers (`01-bug_report.yml`, `02-feature_request.yml`) if you need a specific order. Required fields now also work in **private repos**. Separately, the new "Issue Fields" structured-metadata feature entered public preview on 2026-03-12 — preview only; do not recommend yet for canonical templates. | ||
|
|
||
| ```yaml | ||
| name: Bug Report | ||
| description: Report a bug to help us improve | ||
|
|
@@ -215,6 +217,13 @@ body: | |
| label: Relevant logs | ||
| description: Paste any relevant error messages or logs. | ||
| render: shell | ||
| - type: attachments | ||
| id: artefacts | ||
| attributes: | ||
| label: Logs, screenshots, or crash reports | ||
| description: Drag and drop files (logs, screenshots, video) so we have everything needed to reproduce. | ||
| validations: | ||
| required: false | ||
| ``` | ||
|
|
||
| ## .github/ISSUE_TEMPLATE/feature_request.yml | ||
|
|
@@ -306,9 +315,18 @@ Closes # | |
| github: [username] | ||
| # ko_fi: username | ||
| # open_collective: project-name | ||
| # patreon: project-name | ||
| # polar: org-or-user # developer-focused funding (added to GitHub's allowlist) | ||
| # liberapay: project-name | ||
| # tidelift: npm/package-name # npm:foo, pypi:foo, etc. | ||
| # buy_me_a_coffee: username | ||
| # thanks_dev: u/username # GitHub Sponsors alternative | ||
| # issuehunt: org/repo | ||
| # custom: ["https://example.com/donate"] | ||
|
Comment on lines
+318
to
325
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🧩 Analysis chain🌐 Web query:
💡 Result: Supported funding platforms in a GitHub FUNDING.yml file (as of 2026-05-08): - GitHub Sponsors: Citations: Fix two FUNDING.yml key formats to match GitHub's specification. The template has inaccurate value formats for two funding platforms:
The patreon, polar, liberapay, tidelift, buy_me_a_coffee, and custom keys are correctly formatted. 🤖 Prompt for AI Agents |
||
| ``` | ||
|
|
||
| GitHub displays funding links from this file as a "Sponsor" button on the repository page. See [GitHub's customizing-your-repository docs](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository) for the full list of supported keys. | ||
|
|
||
| ## SUPPORT.md | ||
|
|
||
| ```markdown | ||
|
|
||
| Original file line number | Diff line number | Diff line change | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -1,11 +1,23 @@ | ||||||||||||||
| --- | ||||||||||||||
| name: visual-standards | ||||||||||||||
| description: Visual formatting standards for repository documentation — emoji heading prefixes, horizontal rules, TOC anchors, callouts, screenshots (device dimensions, HTML patterns, captions, shadows), and image optimisation. Load when generating READMEs with visual elements or working with screenshots. | ||||||||||||||
| argument-hint: "[topic: 'screenshots', 'emoji', 'captions', or general]" | ||||||||||||||
| allowed-tools: Read Glob Grep | ||||||||||||||
| version: "1.0.0" | ||||||||||||||
| --- | ||||||||||||||
|
|
||||||||||||||
| # Visual Standards | ||||||||||||||
|
|
||||||||||||||
| ## Invocation | ||||||||||||||
|
|
||||||||||||||
| Load visual formatting reference for emoji heading prefixes, horizontal rules, TOC anchors, callouts, screenshot dimensions, HTML patterns, captions, shadows, and image optimisation. | ||||||||||||||
|
|
||||||||||||||
| **Use when:** | ||||||||||||||
| - Adding screenshots or demo GIFs to a README | ||||||||||||||
| - Setting up emoji heading prefixes for a long README | ||||||||||||||
| - Checking device-specific capture dimensions | ||||||||||||||
| - Working with captions, shadows, or image annotations | ||||||||||||||
|
|
||||||||||||||
| ## Emoji Heading Prefixes | ||||||||||||||
|
|
||||||||||||||
| Use a single emoji before each H2 heading to create visual anchors when scrolling. | ||||||||||||||
|
|
@@ -71,3 +83,20 @@ Reserve GitHub callout syntax for GitHub-only documents (issue templates, PR tem | |||||||||||||
| ## Screenshots & Device Images | ||||||||||||||
|
|
||||||||||||||
| For device-specific capture dimensions, HTML display patterns, retina handling, annotation conventions, captions, shadows/borders, browser chrome, file naming, and optimisation guidance, load `SKILL-reference.md` from this skill directory. | ||||||||||||||
|
|
||||||||||||||
| ## Diagrams (Mermaid) | ||||||||||||||
|
|
||||||||||||||
| Mermaid renders natively on GitHub and GitLab; npm and PyPI strip it. For multi-renderer READMEs, **pre-render to SVG/PNG and reference the static asset** — the Mermaid source can live alongside in `docs/diagrams/` for editability. | ||||||||||||||
|
|
||||||||||||||
| | Diagram type | When to use | | ||||||||||||||
| |--------------|-------------| | ||||||||||||||
| | `flowchart` | Decision trees, control flow, data pipelines | | ||||||||||||||
| | `sequenceDiagram` | API call traces, request/response timing | | ||||||||||||||
| | `classDiagram` | Type relationships, ORM mappings | | ||||||||||||||
| | `stateDiagram-v2` | State machines, lifecycle docs | | ||||||||||||||
| | `gitGraph` | Branch strategy / release flow visualisation | | ||||||||||||||
| | `wardleyMap` | Strategy diagrams — capability evolution from genesis → custom → product → commodity (Mermaid 11+) | | ||||||||||||||
|
|
||||||||||||||
| **Styling:** Mermaid 2026's "neo look" refresh applies cleaner defaults to flowchart, class, sequence, state, and gitGraph diagrams. To opt into the new defaults explicitly, set `%%{init: {"look": "neo"}}%%` at the top of the diagram block. To keep the classic look across versions, use `"look": "classic"`. | ||||||||||||||
|
Comment on lines
+98
to
+100
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Tighten the Mermaid minimum version from "Mermaid 11+" to "Mermaid 11.14.0+". Both 📝 Proposed fix-| `wardleyMap` | Strategy diagrams — capability evolution from genesis → custom → product → commodity (Mermaid 11+) |
+| `wardleyMap` | Strategy diagrams — capability evolution from genesis → custom → product → commodity (Mermaid 11.14.0+) |
-**Styling:** Mermaid 2026's "neo look" refresh applies cleaner defaults to flowchart, class, sequence, state, and gitGraph diagrams.
+**Styling:** Mermaid's "neo look" (11.14.0+) applies cleaner defaults to flowchart, class, sequence, state, and gitGraph diagrams.📝 Committable suggestion
Suggested change
🤖 Prompt for AI Agents |
||||||||||||||
|
|
||||||||||||||
| **GitHub theme handling:** GitHub auto-syncs the Mermaid theme to dark mode **only when no `%%{init}%%` theme is set**. If you pin a theme, light/dark mode users see the same colours — verify both in preview before merging. | ||||||||||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Orphaned sentence — duplicate of content already in the new Invocation section.
Line 24 (
Generate structured, LLM-friendly content indexes following the [llmstxt.org](https://llmstxt.org/) specification.) is a leftover from the pre-refactor body. The Invocation section (line 13) already states the same thing. The sentence now sits awkwardly between## Invocationand## Backgroundwith no heading of its own.🗑️ Proposed fix
📝 Committable suggestion
🤖 Prompt for AI Agents