readme SKILL.md skillB
readme from gufranco/claude-engineering-rules is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add gufranco/claude-engineering-rules/readme@git:20261029.8b030eePins git:20261029.8b030ee in mdr.lock. Pin the fingerprint instead.
- Audit grade
- B, 16 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- gufranco/claude-engineering-rules
- Path
skills/readme/SKILL.md- Versions recorded
- 5
- Latest version
- git:20261029.8b030ee, committed Oct 29, 2026
- First version recorded
- Oct 29, 2026
- Size
- 59,623 bytes
- Repository stars
- 3
- License
- MIT
Generate a README and GitHub repo description from the actual codebase, always in English, Japanese, Simplified Chinese and Hong Kong Traditional Chinese, in the marketing variant or the --variant assessment variant.
Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.
What the file says
## Overview Generate a README and GitHub repository description grounded in the actual codebase. Every run writes four files: the English README plus its Japanese, Simplified Chinese and Hong Kong Traditional Chinese translations. Two variants are supported: marketing (default) and assessment (`--variant assessment`). The marketing variant is for a public repository: what the project is, how to install it, how to use it, and where to get help, in that order. The assessment variant reads like an engineering memo: tables for every section and design decisions written as narrative paragraphs. Every claim in both variants is grounded in the actual codebase, and every file the skill writes passes the slop gate in Phase 5. Never invent features. ## When to use - When starting a new project that needs a professional README. - When a project has outgrown its initial README and needs a rewrite. - When preparing a project for public release or portfolio showcase. - When the README is stale and no longer reflects the codebase. - When you want the project to stand out on GitHub. ## When NOT to use - For minor README tweaks like fixing a typo or adding one section. …
Read the whole file at its exact version.
How to install
mdr add gufranco/claude-engineering-rules/readme@sha256:cfea5dca8dd6c0ddThe line at the top of this page pins the label git:20261029.8b030ee, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.
[](https://markdownregistry.com/a/art_gp23rex2swxqwhsf)
1 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 5 versions of this file, all committed on Oct 29, 2026.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| git:20261029.8b030ee latest | 2026-10-29 | 8b030ee | 59,623 B | B | view · diff |
| git:20261029.d6fde68 | 2026-10-29 | d6fde68 | 60,476 B | B | view · diff |
| git:20261029.fef586f | 2026-10-29 | fef586f | 59,608 B | B | view · diff |
| git:20261029.9a5bf21 | 2026-10-29 | 9a5bf21 | 59,405 B | B | view · diff |
| git:20261029.db0f2a0 | 2026-10-29 | db0f2a0 | 59,028 B | B | view |
Audit of the latest version
- fail: No instruction to read or print local credentials (matched: read `.env)
- pass: Frontmatter block present
- pass: Frontmatter declares a name
- pass: Frontmatter declares a description
- pass: Size between 200 bytes and 200 KB (59623 bytes)
- pass: No zero-width or bidi control characters
- pass: No instruction hidden inside an HTML comment
- pass: No link to an exfiltration or paste host
- pass: No credential-shaped string
- pass: No instruction to send local credentials anywhere
- pass: No text hidden with inline styles
- pass: No prompt-injection phrasing
- pass: No curl or wget piped into a shell
- pass: No recursive delete of root, home or parent
- pass: No base64 blob over 200 characters
- pass: No link to a raw IP address
- pass: No script tag
Starting a new one? Use a template for SKILL.md on mdpantry, which passes every one of these checks and says what to change in it.
Source
gufranco/claude-engineering-rules · 3 stars · license MIT · pushed 2026-10-30 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_gp23rex2swxqwhsf GET https://markdownregistry.com/api/v1/resolve?ref=gufranco/claude-engineering-rules/readme GET https://markdownregistry.com/api/v1/blob/cfea5dca8dd6c0dda0aaab2cb9d223930a2205c0cbc93e88d0438492967fe207
Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.
Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.
More from gufranco/claude-engineering-rules
Every file in gufranco/claude-engineering-rules