Skip to content

Add nuxt-style-readme skill 🤖🤖🤖 - #3138

Open
JonathanXDR wants to merge 1 commit into
github:mainfrom
JonathanXDR:add-nuxt-style-readme-skill
Open

JonathanXDR wants to merge 1 commit into
github:mainfrom
JonathanXDR:add-nuxt-style-readme-skill

Conversation

@JonathanXDR

Copy link
Copy Markdown

Pull Request Checklist

  • I have read and followed the CONTRIBUTING.md guidelines.
  • I have read and followed the Guidance for submissions involving paid services.
  • My contribution adds a new instruction, prompt, agent, skill, workflow, or canvas extension file in the correct directory.
  • The file follows the required naming convention.
  • The content is clearly structured and follows the example format.
  • I have tested my instructions, prompt, agent, skill, workflow, or canvas extension with GitHub Copilot.
  • I have run npm start and verified that README.md is up to date.
  • I am targeting the main branch for this pull request.

Description

Adds nuxt-style-readme, a skill that writes and refines a repository's README in the concise style the Nuxt ecosystem popularized: short introduction, feature-oriented presentation, fast path to first success, minimal ceremony.

Two rules separate it from generic README generation. Sections are chosen from evidence in the repository rather than from a fixed template, so a section exists only when the repo gives it something real to hold. And every command, package name, environment variable, version requirement, and capability claim has to trace back to a file that was actually read, or it is left out.

It refuses to fabricate the things README generators most often invent: badges stating facts the repository does not prove, banners with no committed asset, Documentation or Playground links with dead targets, install commands for unpublished packages, and licenses the repo never declared.

Bundled assets are references/section-rules.md (an inclusion test per optional section), references/style-guide.md (voice, headings, tables, alerts, license wording), and assets/readme-template.md (a skeleton used only when building from nothing).

Source repository: https://github.com/JonathanXDR/nuxt-style-readme (MIT).


Type of Contribution

  • New instruction file.
  • New prompt file.
  • New agent file.
  • New plugin.
  • New skill file.
  • New agentic workflow.
  • New canvas extension.
  • Update to existing instruction, prompt, agent, plugin, skill, workflow, or canvas extension.
  • Other (please specify):

Additional Notes

On overlap, since this is the obvious question: create-readme and readme-blueprint-generator both already exist. create-readme writes an appealing README from the project. readme-blueprint-generator derives one from .github/copilot files and copilot-instructions.md. This skill differs in what it refuses to do rather than in what it produces. It treats unproven claims as defects, so its main output pressure is omission, and it declines work that is not a README at all, such as changelogs, release notes, and API reference. If maintainers still consider that too close to the existing two, I am happy to close this and keep only the lean-comments submission (#3137).

On the one unchecked box: this skill has been used in regular agent work and validated against this repository's gates (npm run skill:validate passes for all 419 skills, npx @microsoft/vally-cli lint skills/nuxt-style-readme reports 2/2 checks passed), but I have not run it specifically inside GitHub Copilot, so I left that box unticked rather than tick it on assumption.

docs/README.skills.md was regenerated with npm start and contains exactly the one new row.

@github-actions github-actions Bot added new-submission PR adds at least one new contribution skills PR touches skills labels Sep 14, 2026
@github-actions

Copy link
Copy Markdown
Contributor

🔒 PR Risk Scan Results

Scanned 4 changed file(s).

Severity Count
🔴 High 0
🟠 Medium 1
ℹ️ Info 0
Severity Rule File Line Match
🟠 unpinned-version-indicator skills/nuxt-style-readme/references/style-guide.md 108 [npm-version-src]: https://img.shields.io/npm/v/<package>/latest.svg?style=flat&colorA=18181B&colorB=28CF8D

This is an automated soft-gate report. Findings indicate review targets and do not block merge by themselves.

@github-actions

Copy link
Copy Markdown
Contributor

🔴 Contributor Reputation Check: HIGH risk

Check Risk
Profile HIGH
Credential audit NONE

Maintainers: please review this contributor before merging.
See the workflow run for full details.
Automated check powered by AGT.

@github-actions github-actions Bot added needs-review:HIGH Contributor reputation check flagged HIGH risk skill-check-error Skill validator reported errors labels Sep 14, 2026
@github-actions

Copy link
Copy Markdown
Contributor

🔍 Vally Lint Results

⛔ Findings need attention

Scope Checked
Skills 1
Agents 0
Total 1
Severity Count
❌ Errors 1
⚠️ Warnings 0
ℹ️ Advisories 0

Summary

Level Finding
nuxt-style-readme (1/2 checks passed, 1 failed)
Full linter output
### Linting skills/nuxt-style-readme
❌ nuxt-style-readme (1/2 checks passed, 1 failed)
    ✓ [spec-compliance] All 1 skill(s) are spec-compliant.
        ✓ spec-compliance: All spec checks passed.
    ✗ [valid-refs] 1 of 1 skill(s) have invalid file references.
        ✗ valid-refs: Found 1 invalid file reference(s): url (missing).

1 skill(s) linted, 1 failed

Note: Vally lint returned a non-zero exit code. Please review the findings above before merge.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

needs-review:HIGH Contributor reputation check flagged HIGH risk new-submission PR adds at least one new contribution skill-check-error Skill validator reported errors skills PR touches skills

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant