Contributing

Help make the handbook clearer for the next person.

You do not need to be a professional developer to contribute. If you can improve an explanation, catch something outdated, or make a chapter easier to understand, you can help.

Good contributions are simple. Fix a typo. Improve a confusing paragraph. Add a better analogy. Open an issue when something feels off.

This community edition builds on the original Vibe Coder's Handbook repository by Nasser AlNasser. The website and community edition live at h4harsimran/vibe-coders-handbook.

What You Can Contribute

Type How
Fix a typo or grammar issue Edit the relevant chapter file.
Improve an explanation Rewrite the confusing section in plainer language.
Add an analogy or example Make the concept easier for non-developers to grasp.
Correct outdated information Update the chapter and explain what changed.
Add a new chapter or section Open an issue first, then submit the draft.
Report a problem Open a GitHub issue even if you are not fixing it yourself.

Where The Content Lives

All chapter content lives in:

src/content/chapters/

Each file is one chapter. The filename controls the URL. For example:

04-frontend-frameworks.md -> /chapters/frontend-frameworks

How To Contribute

Option 1: Edit On GitHub

  1. Find the chapter file you want to edit in src/content/chapters/.
  2. Click the pencil icon on GitHub.
  3. Make your change.
  4. Create a new branch and open a pull request.

That is the easiest path, and it is enough for most contributions.

Option 2: Work Locally

If you are making a larger change, fork the repo and run it locally:

git clone https://github.com/YOUR_USERNAME/vibe-coders-handbook.git
cd vibe-coders-handbook
npm install
npm run dev
npm run check

Writing Guidelines

This handbook is for people who are still trying to make sense of the modern JavaScript ecosystem. Write like you are explaining something to a smart friend, not defending a thesis.

  • Use plain language.
  • Prefer examples and analogies over jargon.
  • Use ## for main sections and ### for subsections.
  • Do not use # inside chapter bodies.
  • Use root-relative links like /chapters/javascript-and-typescript.

Frontmatter Example

---
order: 4
chapterLabel: "Chapter 4"
title: "Your Chapter Title"
description: "One sentence describing what this chapter covers."
tools: ["Tool1", "Tool2"]
published: true
draft: false
lastUpdated: "2026-03-01"
---

Pull Request Notes

Keep pull requests focused and explain what changed. If the update fixes something inaccurate, mention why. If you want to add a bigger chapter or restructure part of the handbook, open an issue first so the direction is aligned before you spend time on it.

What We Avoid

  • Needlessly complicated explanations.
  • Content that promotes a company or paid product.
  • Unverified technical claims.
  • Large AI-generated dumps that have not been edited with care.

Questions?

Open an issue on GitHub and ask. A contribution does not need to be huge to matter.