[FEATURE] Add CONTRIBUTING.md guide for community contributors

Open Beginner friendly
  • Is something wrong?
#108,192 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
73/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
typescript
Domain
documentation

Research direction

Start by reading the top-level CLAUDE.md and mods/README.md to gather existing guidance, then inspect the mods/, plugins/, examples/ and scripts/ directories. Add a top-level CONTRIBUTING.md covering repository layout, local validation commands, contribution workflow, DevContainer setup, and the Code of Conduct link. Done when the guide provides the requested community starting point and its commands and links are accurate.

Written by the indexing model from the issue text.

Description

area:docs documentation enhancement
Problem Statement

The repository currently lacks a dedicated top-level CONTRIBUTING.md guide. While CLAUDE.md and mods/README.md provide guidance for coding agents and internal mods, community contributors navigating the repository do not have a single standard starting point covering:

  • Repository layout and structure (mods/, plugins/, examples/, scripts/)
  • How to test changes locally (e.g. running claude plugin test, typechecking with tsc -p mods/tsconfig.json)
  • Issue and PR workflow standards
  • DevContainer / environment setup
Proposed Solution

Add a top-level CONTRIBUTING.md that:

  1. Links to the Code of Conduct and welcomes community contributions.
  2. Describes the directory structure and where to contribute (e.g., mods, examples, docs).
  3. Outlines local testing, typechecking, and validation commands.
  4. Explains how to submit bug reports, feature requests, and pull requests.
Priority

Medium - Would be very helpful

Category

Documentation

Dominant language
TypeScript
Stars
154k
Forks
25.6k
Avg merge
12h 27m
Merged PRs (30d)
4

Getting set up

Open in Codespaces

Starts the project's dev container in your browser, under your own GitHub account.

  • No Dockerfile or Docker Compose file
  • No pull request template
  • No contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from anthropics/claude-code

All issues in anthropics/claude-code

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.