Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
83 lines (61 loc) · 2.6 KB

CONTRIBUTING.md

File metadata and controls

83 lines (61 loc) · 2.6 KB

Contributing to Claude Code Guide

Thanks for wanting to help. Here's how to make it easy for both of us.

The Fastest Contributions (No Coding)

Content Structure

content/docs/
  foundations/     # Core concepts (CLAUDE.md, sessions, memory, permissions)
  workflows/       # Daily practice, debugging, team adoption, CI/CD
  patterns/        # Advanced features (hooks, agents, MCP, autonomous loops)
  templates/       # Copy-paste CLAUDE.md files
  comparisons/     # Claude Code vs other tools

The Voice (This Is Important)

Every page should sound like a practitioner talking to a friend. Not documentation. Not a textbook.

Do this:

  • Hook with a real question or hot take
  • Take clear stances ("this is great" / "this is a waste of time")
  • Short paragraphs, conversational rhythm
  • Say "here's the deal" or "let me be real"

Don't do this:

  • "In this section, we will explore..."
  • "It is important to note that..."
  • Walls of text without examples
  • Feature lists without opinions

Every Page Needs a DemoCard

No exceptions. Every page must have at least one interactive terminal animation showing the feature in action:

<DemoCard title="What you'll see" steps={[
  { type: 'cmd', text: 'claude "your prompt here"' },
  { type: 'out', text: 'Claude Code output...' },
  { type: 'success', text: '✓ Something good happened' },
  { type: 'error', text: '✗ Something went wrong' },
  { type: 'warn', text: '→ The takeaway message' },
]} />

Step types: cmd (user input), out (output), success (green), error (red), warn (amber).

Adding a New Page

  1. Create a .mdx file in the right folder
  2. Add frontmatter:
---
title: Your Page Title
description: "A punchy one-liner. Not a paragraph."
---
  1. Write content following the voice guide above
  2. Add at least one DemoCard
  3. Add the page slug to the folder's meta.json
  4. Open a PR

Running Locally

npm install
npm run dev

Open localhost:3000.

Code of Conduct

Be kind. Be helpful. Everyone starts somewhere. If someone's contribution doesn't match the voice, help them fix it instead of rejecting it.