القائمة
Conventions for Pony library project READMEs. Load when writing or updating a README.md for a ponylang library project.
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
استنادا إلى تصنيف SOC المهني
How the words go in a comment, docstring, release note, README, or a project's AGENTS.md — write plainly, say the fact, and stop. Load before writing any prose that ships with the code. Language-agnostic.
Structured debugging protocol with checkpoints. Load when debugging non-trivial issues — before forming any hypothesis about the cause.
Load the Pony language reference (capabilities, PonyCheck, stdlib pitfalls, mort pattern). Load it before Pony coding sessions.
What belongs in a project's AGENTS.md and what never does. Load before writing or changing AGENTS.md or CLAUDE.md. Language-agnostic.
Ensemble code review with specialized reviewer personas. Has full (9-persona) and lightweight (4-persona) modes. Load when conducting a code review of a PR, branch, or local changes.
What earns a comment, what never belongs in one, and what to do when two distant things must change together. Load before writing or changing any comment or docstring. Language-agnostic.
| name | pony-library-readme |
| description | Conventions for Pony library project READMEs. Load when writing or updating a README.md for a ponylang library project. |
| disable-model-invocation | false |
These conventions are derived from existing ponylang library READMEs and should be followed when writing or updating a README.md for a Pony library project.
Load pony-prose for how the prose reads. This skill says what a README holds; pony-prose says how to write it plainly.
Every Pony library README has these sections in this order:
Title (#) — Lowercase matching the repo/package name (e.g., # glob, # web_link). Use proper capitalization only for proper nouns or acronyms (e.g., # PEG, # Lori, # GitHub REST API).
Intro paragraph (no heading) — 1-2 sentences describing what the library does. No section heading.
## Status — Short maturity statement. Common values:
Production ready.Beta[Name] is beta-level software.[Name] is beta quality software that will change frequently. Expect breaking changes. That said, you should feel comfortable using it in your projects.## Installation — Standard 5-bullet list using * markers:
* Install [corral](https://github.com/ponylang/corral)
* `corral add github.com/ponylang/<name>.git --version <X.Y.Z>`
* `corral fetch` to fetch your dependencies
* `use "<package>"` to include this package
* `corral run -- ponyc` to compile your application
If the package has sub-packages, the use bullet gets sub-bullets listing each (e.g., use "ssl/crypto", use "ssl/net").
## API Documentation — A markdown link to the docs: [https://ponylang.github.io/<name>](https://ponylang.github.io/<name>). This is always the last section (or near-last if a project-specific section follows).
These go between Installation and API Documentation, in this order:
## Dependencies — Only include when the library requires native C libraries the user must install (e.g., libpcre2, OpenSSL). If the dependency is transitive via the ssl package, a note after the installation bullets linking to ssl's installation instructions is sufficient instead of a full section.
## Usage — Always include an inline code example showing core usage (a complete short program or a structural skeleton). Point to the examples/ directory for more.