Write a README and publish my first coding project on GitHub
A clear README, a safe publishing checklist, and a short post to share what you built.
The prompt
Help me write a README and publish my first coding project on GitHub.
Project name: [NAME]
What it does and who it's for: [ONE OR TWO SENTENCES]
Language, libraries, and tools: [LIST]
How to install and run it: [STEPS I USE]
Example input and output or screenshots: [DESCRIBE]
What I learned building it: [NOTES, or paste my review from step 4]
Known limitations and ideas for next: [LIST]
Return:
1. A README in Markdown with: project title and one-line description, screenshot or demo placeholder [ADD SCREENSHOT], features, installation steps, usage example, tech used, what I learned, known limitations, next steps, and how to contact me. Keep it scannable and honest; don't overstate what the project does.
2. A publishing checklist:
- Remove passwords, API keys, tokens, and personal data from the code and its history; use environment variables or a config file that is excluded.
- Add a .gitignore suitable for my language.
- Choose a license (briefly explain the common options; this is general information, not legal advice).
- Write clear commit messages going forward.
- Pin the repository on my profile.
3. A short post (under 120 words) for LinkedIn or a community forum describing what I built and learned, without hype.
This is step 5 of the "Learn to code by building your first project" pack. It works on its own, and the published project can go straight into the "Build a portfolio that gets you hired" pack.
Highlighted [brackets] are blanks to replace with your own details.
Fill in the blanks and use this promptMore Software Development prompts
What to fill in
- NAME
- ONE OR TWO SENTENCES
- LIST
- STEPS I USE
- DESCRIBE
- NOTES, or paste my review from step 4
- ADD SCREENSHOT
How this prompt is built
This prompt follows the RTF structure (Role, Task, Format). RTF tells the model who to be, what to do and what shape the answer should take. It is the quickest structure that still gives noticeably better results than a bare request.
Related prompts
- Get a beginner-friendly code review of my first projectA ranked set of the five improvements that matter most, explained simply, plus what you did well and what to learn next.
- Audit the developer experience of my software package or APIA structured review of your docs, onboarding, community signals, and competitor position, with a prioritized list of developer-experience fixes.
- Find and fix a race condition or concurrency bugAnalyzes code for race conditions, deadlocks, and lost updates, explains the exact interleaving that fails, and proposes a safe fix.
- Make background jobs and webhooks safe to retryDesigns idempotency, retries, and dead-letter handling so jobs, queue consumers, and webhooks never double-charge or lose work.