Keep AI files with the project
Store prompts, rules, memory files, instructions, and skill files in the repo. A skill should explain what it does and why the project needs it.
AI Best Practices
A good AI workflow should not be lost in chat history. Turn it into a small, documented skill that can be installed, tested, and updated.
Store prompts, rules, memory files, instructions, and skill files in the repo. A skill should explain what it does and why the project needs it.
A good skill does one repeated job: review code, summarize issues, write release notes, generate tests, or explain product context. Small skills are easier to test and update.
Include the goal, context, limits, examples, expected output, and known problems. A teammate should understand the skill before running it.
Say whether the package supports Cursor, Claude, Codex, or another assistant. Tool files should go into predictable folders.
Before publishing, try the skill on work that looks like real use. Keep a short checklist for expected behavior, wrong behavior, and edge cases.
Do not package API keys, customer data, private prompts, credentials, or internal documents. Use ignore files and review the preview before publishing.
Input and output examples help assistants follow the right pattern. Keep examples short, specific, and easy to scan.
Changing a skill can change how teammates work. Use a new version and explain what changed.
For important work, make the skill draft, inspect, and explain. Do not make it take irreversible action silently.
Say what to do if install fails, a tool is unsupported, a generated file is wrong, or a user needs an older version.
This page turns public AI guidance into practical AIPM advice. These references are good starting points for teams building reusable AI workflows.