Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
75 changes: 75 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
# Contributing to Claude Code Community Patterns

First off, thank you for considering contributing! This repository is built on the belief that **sharing agentic workflows multiplies our collective productivity.**

Whether you're fixing a typo, adding a new slash command, or documenting a complex multi-agent workflow, your help is appreciated.

## 🌟 What We're Looking For

We specifically encourage contributions in these three areas:

### 1. Custom Commands (`/commands`)
Have you written a custom command that automates a tedious task?
* **Examples:** Automated test runners, documentation generators, code style fixers, or security scanners.
* **Requirement:** Commands must be generic enough to be useful to others (or easily adaptable).

### 2. Context Templates (`CLAUDE.md`)
Have you cracked the code on how to prompt Claude for a specific tech stack?
* **Examples:** A `CLAUDE.md` optimized for Next.js 14, a Python/Django context that prevents circular import errors, or a Unity C# setup.
* **Requirement:** Include comments explaining *why* certain rules are included.

### 3. Workflows & Guides
Have you found a reliable process for "pair programming" with Claude?
* **Examples:** "How to use Claude to refactor legacy code safely" or "A workflow for writing comprehensive unit tests."

---

## 🚀 How to Contribute

### Step 1: Fork & Branch
1. Fork the repository to your own GitHub account.
2. Create a new branch for your feature:
```bash
git checkout -b feature/your-command-name
```

### Step 2: Add Your Content
Please follow our directory structure:

* **Commands** go in `commands/{category}/your-command.md`
* **Templates** go in `templates/{stack}/CLAUDE.md`
* **Workflows** go in `workflows/your-workflow-guide.md`

#### Style Guide for Commands
When adding a new command, please include a **metadata header** at the top of the file so users know what it does.

**Example Format:**
```markdown
(Your prompt content goes here...)

```

### Step 3: Submit a Pull Request

1. Push your branch to GitHub.
2. Open a Pull Request (PR) against the `main` branch of this repository.
3. **In your PR description, please answer:**
* What problem does this solve?
* How have you tested it? (e.g., "Used this on a React project for 2 weeks")



---

## 🧪 Testing Your Contributions

Before submitting, please **test your command or template** in a fresh environment if possible.

* **For Commands:** Does it work if the project structure is slightly different?
* **For Templates:** Does it consume too many tokens unnecessarily?

## 📜 License

By contributing, you agree that your contributions will be licensed under the MIT License defined in the `LICENSE` file of this repository.

Thank you for helping us build the ultimate manual for Claude Code!
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2025

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
90 changes: 89 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,89 @@
# claude-code
# Claude Code: Community Patterns, Commands & Context

[![Contributions Welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg)](CONTRIBUTING.md)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)

**A curated library of efficient slash commands, `CLAUDE.md` templates, and agentic workflows for software engineering with Claude Code.**

## 📖 About This Repository

Claude Code is a powerful agentic interface that acts as an AI development team member. However, its true power "multiplies when we share proven patterns."

This repository serves as a centralized knowledge base for:
* **Custom Commands (`/commands`):** Reusable prompts that automate complex tasks like testing, documentation, or refactoring.
* **Context Templates (`CLAUDE.md`):** Best-practice structures for teaching Claude about your project's architecture and rules.
* **Process Documentation:** Guides on how to "pair program" effectively with AI agents to solve specific engineering challenges.

The goal is to help developers skip the trial-and-error phase and jump straight to productive, AI-assisted development.

---

## 📂 Repository Structure

The repository is organized by resource type:

```text
.
├── commands/ # Custom slash commands (e.g., /test, /doc, /refactor)
│ ├── testing/ # Commands for running and fixing tests
│ ├── docs/ # Commands for generating documentation
│ └── architecture/ # Commands for analyzing code structure
├── templates/ # CLAUDE.md templates for different project types
│ ├── react/ # Context templates for React apps
│ ├── python/ # Context templates for Python/Django/Flask
│ └── generic/ # Universal project context structures
└── workflows/ # Guides on multi-step agentic processes

```

---

## 🚀 How to Use These Resources

### 1. Using Custom Commands

Claude Code allows you to create custom "slash commands" by placing markdown files in a `.claude/commands` directory in your project.

1. Navigate to the `commands/` directory in this repo.
2. Choose a command (e.g., `document-feature.md`).
3. Copy the file into your local project: `.claude/commands/document-feature.md`.
4. Run it in Claude Code by typing `/document-feature`.

### 2. Adopting a `CLAUDE.md` Template

The `CLAUDE.md` file is the "brain" of your project's context.

1. Navigate to `templates/` and find a stack that matches yours.
2. Copy the content into a file named `CLAUDE.md` at the root of your project.
3. **Customize it:** Fill in your specific build commands, linting rules, and architectural constraints.

---

## 🤝 How to Contribute

We welcome contributions! If you have developed a workflow that saves you time or improves code quality, please share it.

### What we're looking for:

* **High-Leverage Commands:** Scripts that turn 30 minutes of work into 30 seconds.
* **Robust Contexts:** `CLAUDE.md` files that effectively prevent hallucinations or style errors.
* **Novel Workflows:** Creative ways to use Claude for design, debugging, or planning.

### Submission Guidelines

1. **Fork** this repository.
2. **Create a branch** for your contribution (`git checkout -b feature/amazing-test-command`).
3. **Add your file** to the appropriate directory.
* *Naming:* Use clear, descriptive filenames (e.g., `generate-unit-tests.md` rather than `tests.md`).


4. **Add Metadata:** If possible, include a short comment block at the top of your file describing what it does and any prerequisites.
5. **Submit a Pull Request** with a description of the problem your contribution solves.

---

## ⚖️ License

This project is licensed under the MIT License - see the [LICENSE](https://www.google.com/search?q=LICENSE) file for details.

> **Note:** This is a community-driven resource. Always review commands and prompts to ensure they align with your specific project requirements and security standards before running them.
Loading