agentleFS
RichardMcQuiston01RichardMcQuiston01/unofficial-claude-skill-examples/skills/npm-registry/SKILL.md

npm-registry

Skill1 starsChanged 3 months agoApache-2.0View on GitHub

Guidelines for publishing projects to NPM registry

The file

We split this skill into the rules it gives an agent

5 rules. About 0 are common, 4 are distinctive, and 1 is very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈4

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Keep README.md file updated with instructions for prerequisites, installation, and usage of a project's feature(s)

    line 8
  2. Distinctive:

    Update CHANGELOG.md prior to creating a PR or MR.

    line 9
  3. Distinctive:

    If a CHANGELOG.md file does not exist, create one and use the Git history to fill it out for starters.

    line 14
  4. Distinctive:

    If a LICENSE file does not exist, create one and ask the User to confirm which License to utilize.

    line 15
  5. Very specific:

    Add a Support section to README.md file if it does not already exist, which contains donation link to PayPal or [see examples/README.md]

    line 18

≈ “Common” is an estimate: at least 1 in 5 of the 364,980 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Rules

  • Keep README.md file updated with instructions for prerequisites, installation, and usage of a project's feature(s)
  • Update CHANGELOG.md prior to creating a PR or MR.
  • README.md should have a License section with notes and a link to LICENSE file within the root directory [see examples/LICENSE].

Instructions

  • If a CHANGELOG.md file does not exist, create one and use the Git history to fill it out for starters.
  • If a LICENSE file does not exist, create one and ask the User to confirm which License to utilize.
  • NPM packages should use the @richardmcquiston01 prefix unless otherwise specified. Fill this info into the package.json for any project that the User intends to pubish to the NPM registry.
  • The email address for package.json files and the like should use email.redacted@gmail.com
  • Add a Support section to README.md file if it does not already exist, which contains donation link to PayPal or [see examples/README.md]
  • During final testing, code should all be merged to 'staging' branch'
  • Once code is ready for publishing to NPM, the version number should be incremented and CHANGELOG.md updated before merging to 'release' via a PR.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.