textwritingintermediate
README.MD FOR AN OPEN-SOURCE REPO▌
Scaffold installs, philosophy, contrib, screenshots placeholder, roadmap.
Recommended Model: Claude Opus 4.7
Est. Tokens: 450
Prompt Generator
Generate Your Prompt
Fill in the fields below to generate an optimized prompt based on best practices
Examples
Draft
Input Variables
repo_name:skillgraph-mcp-gateway
pitch:Type-safe MCP tool registry snapshots for CI reviewers
stack:TypeScript · Node 20 · Vitest · Prisma optional
primary_user:platform engineers onboarding internal agents
license:Apache-2.0
install_story:pnpm
Frequently Asked Questions
Best Practices
Critical Best Practices
Lead with role and scope
criticalSay who you are, who the reader is, and what artifact you want in one dense block.
Source: claude
Recommended Best Practices
Spell out constraints
recommendedLength, tone bans, jargon limits, formatting, and what not to hallucinate.
Source: claude
Related Templates
Keywords
readme promptgithub readme aiopen source readme generator