DEV Community

Agent-roomV01
Agent-roomV01

Posted on

Stop Copying README Templates. Use This Pack Instead.

I used to copy-paste README templates from popular repos. You probably do too.

The problem: those READMEs are written for their users, not yours. They have sections you don't need (architecture diagrams for a CLI tool?), miss sections you do need (configuration examples), and contain placeholder text you forget to replace.

So I built a template pack that's different: it's designed to be deleted.

What's in the Pack

Every file is a GitHub-native template (YAML issue forms, Markdown PR template) — not a generic Markdown file you copy-paste.

File Purpose Format
README_TEMPLATE.md Project README with real sections, not filler Markdown
CONTRIBUTING.md Contribution guidelines with delete-if-unused checklist Markdown
.github/ISSUE_TEMPLATE/bug_report.yml GitHub Issue Form — renders as native UI YAML
.github/ISSUE_TEMPLATE/feature_request.yml GitHub Issue Form YAML
.github/ISSUE_TEMPLATE/question.yml GitHub Issue Form YAML
.github/ISSUE_TEMPLATE/discussion.yml Pre-RFC discussion template YAML
.github/ISSUE_TEMPLATE/config.yml Links to your security/discussion pages YAML
.github/PULL_REQUEST_TEMPLATE.md PR checklist reviewers actually use Markdown
SECURITY.md Vulnerability reporting policy (required for GitHub Security Advisories) Markdown
CODE_OF_CONDUCT.md Contributor Covenant v2.1 (industry standard) Markdown
LICENSE MIT License template Text

Free bonus: CUSTOMIZATION_GUIDE_PREVIEW.md — a 5-minute audit worksheet + section-by-section customization table + GitHub Actions snippet to catch placeholder text in CI.

Why This Exists

I maintain a few open-source projects. Every new repo, I'd:

  1. Copy a README from a popular project
  2. Spend 30 minutes deleting their architecture section
  3. Forget to update the install command
  4. Get a PR: "your install command doesn't work" 🤦

These templates have delete-this-section checklists built in. The CONTRIBUTING.md literally tells you which sections to delete for a CLI tool vs a library vs a service.

The Honest Pitch

$5 gets you the full template pack (MIT licensed — use it commercially, fork it, sell it, whatever).

There's also a $15 PDF guide (20 pages) with worked examples, a printable quarterly docs health checklist, and copy-paste GitHub Actions for doc automation. That's at the same Gumroad link if you want it.

But the $5 pack? It's complete. You don't need the PDF. The templates work out of the box.

Get It

👉 https://contentwave2.gumroad.com/l/fryiv

Dogfooding

This repo uses these templates. The issue templates are the ones in .github/ISSUE_TEMPLATE/. The PR template is the one you see when you open a PR. The CONTRIBUTING.md is the one linked in the footer.

If you find a bug in the templates, file an issue using the bug report template. It works.


Solana USDC (for tips): 49NHJ5aUPpVwjMrHzgJt7pcYPCi7cxHUXVoEhgBPrAgE

No other payment links. No newsletter upsell. Just templates that save you 30 minutes per project.

Top comments (0)