Add nuxt-style-readme skill 🤖🤖🤖 - #3138
Open
JonathanXDR wants to merge 1 commit into
Open
JonathanXDR wants to merge 1 commit into
JonathanXDR wants to merge 1 commit into
Conversation
Contributor
🔒 PR Risk Scan ResultsScanned 4 changed file(s).
|
Contributor
|
🔴 Contributor Reputation Check: HIGH risk
Maintainers: please review this contributor before merging. |
Contributor
🔍 Vally Lint Results⛔ Findings need attention
Summary
Full linter output
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Pull Request Checklist
npm startand verified thatREADME.mdis up to date.mainbranch 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), andassets/readme-template.md(a skeleton used only when building from nothing).Source repository: https://github.com/JonathanXDR/nuxt-style-readme (MIT).
Type of Contribution
Additional Notes
On overlap, since this is the obvious question:
create-readmeandreadme-blueprint-generatorboth already exist.create-readmewrites an appealing README from the project.readme-blueprint-generatorderives one from.github/copilotfiles andcopilot-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 thelean-commentssubmission (#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:validatepasses for all 419 skills,npx @microsoft/vally-cli lint skills/nuxt-style-readmereports 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.mdwas regenerated withnpm startand contains exactly the one new row.