|
1 | 1 | # Contributing to Awesome Claude Code |
2 | 2 |
|
3 | | -Thanks for your interest in contributing! This list is community-driven, and every contribution helps. |
| 3 | +Thanks for your interest in contributing! This list is community-driven, and every contribution helps make it the best resource for Claude Code users. |
4 | 4 |
|
5 | | -## Guidelines |
| 5 | +## What We Need |
6 | 6 |
|
7 | | -### Adding a Resource |
| 7 | +| Category | Priority | Examples | |
| 8 | +|----------|----------|---------| |
| 9 | +| Community projects | High | Tools, CLIs, extensions built for Claude Code | |
| 10 | +| CLAUDE.md templates | High | Frameworks not yet covered (Elixir, C#/.NET, Vue, etc.) | |
| 11 | +| Hook recipes | High | Working hooks that solve real problems | |
| 12 | +| Articles & tutorials | Medium | Blog posts, guides, walkthroughs | |
| 13 | +| MCP servers | Medium | Community-built MCP server implementations | |
| 14 | +| Videos | Low | Video tutorials, demos, conference talks | |
| 15 | +| Workflow patterns | Low | Effective prompting strategies, automation scripts | |
8 | 16 |
|
9 | | -1. Fork this repo. |
10 | | -2. Create a branch: `git checkout -b add-resource-name` |
11 | | -3. Add your resource to the appropriate section in `README.md`. |
12 | | -4. Submit a pull request. |
| 17 | +## Quality Criteria |
13 | 18 |
|
14 | | -### What We're Looking For |
| 19 | +To keep this list useful and trustworthy, submissions must meet these standards: |
15 | 20 |
|
16 | | -- Tools, libraries, or servers that work with Claude Code. |
17 | | -- Well-written articles or tutorials about Claude Code workflows. |
18 | | -- CLAUDE.md templates for frameworks/stacks not yet covered. |
19 | | -- Hook recipes that solve real problems. |
20 | | -- Community projects built with Claude Code. |
| 21 | +### For Projects & Tools |
| 22 | +- **Active and maintained** — recent commits within the last 6 months, or stable/feature-complete. |
| 23 | +- **100+ GitHub stars OR unique use case** — popular projects are welcome, but niche tools that solve specific problems are too. |
| 24 | +- **Working and installable** — must have clear setup instructions and actually work. |
| 25 | +- **No spam or low-effort forks** — original work or significant improvements only. |
21 | 26 |
|
22 | | -### Quality Standards |
| 27 | +### For Articles & Tutorials |
| 28 | +- **Substantive content** — not just "I tried Claude Code and it's cool". Should teach something. |
| 29 | +- **Accurate and up-to-date** — outdated articles with deprecated commands will be removed. |
| 30 | +- **English language** — all content must be in English. |
23 | 31 |
|
24 | | -- **No duplicates.** Search existing entries before submitting. |
25 | | -- **Working links.** All URLs must be live and accessible. |
26 | | -- **Descriptions matter.** Every entry needs a concise, helpful description. |
27 | | -- **English only.** All entries and descriptions should be in English. |
28 | | -- **No self-promotion spam.** Your project is welcome if it's genuinely useful, but don't submit low-effort repos just for visibility. |
| 32 | +### For CLAUDE.md Templates |
| 33 | +- **Practical over theoretical** — based on real projects, not hypothetical structures. |
| 34 | +- **Follow the established format** — Project Overview, Commands table, Project Structure tree, Conventions, Environment Variables, Known Issues. |
| 35 | +- **Include explanatory comments** — help users understand and customize. |
29 | 36 |
|
30 | | -### Formatting |
| 37 | +## How to Contribute |
31 | 38 |
|
32 | | -Follow the existing format: |
| 39 | +### Adding a Resource |
| 40 | + |
| 41 | +1. Fork this repo. |
| 42 | +2. Create a branch: `git checkout -b add-resource-name`. |
| 43 | +3. Add your resource to the appropriate section in `README.md`. |
| 44 | +4. Submit a pull request. |
| 45 | + |
| 46 | +### Formatting Rules |
| 47 | + |
| 48 | +Follow the existing format exactly: |
33 | 49 |
|
34 | 50 | ```markdown |
35 | 51 | - [Resource Name](https://link.to/resource) - One-line description ending with a period. |
36 | 52 | ``` |
37 | 53 |
|
38 | 54 | - Use title case for resource names. |
39 | | -- Descriptions should be one sentence, starting with a capital letter and ending with a period. |
| 55 | +- Descriptions: one sentence, starting with a capital letter, ending with a period. |
40 | 56 | - Keep descriptions under 120 characters. |
41 | | -- Place new entries at the end of the relevant section. |
| 57 | +- Place new entries at the **end** of the relevant section. |
| 58 | +- No star count badges or download stats on entries. |
42 | 59 |
|
43 | | -### CLAUDE.md Templates |
44 | | - |
45 | | -If submitting a template: |
| 60 | +### Submitting a CLAUDE.md Template |
46 | 61 |
|
47 | 62 | 1. Place it in `templates/claudemd/`. |
48 | 63 | 2. Name it after the framework/stack (e.g., `django.md`, `svelte.md`). |
49 | | -3. Include comments explaining each section. |
50 | | -4. Keep it practical — real-world over theoretical. |
| 64 | +3. Include the standard header: `# CLAUDE.md — [Framework] Template`. |
| 65 | +4. Include all standard sections (see existing templates for reference). |
| 66 | +5. Include comments explaining each section. |
| 67 | + |
| 68 | +### Reporting Issues |
| 69 | + |
| 70 | +- **Broken link?** [Open an issue](../../issues/new?template=broken-link.yml) or submit a PR to fix/remove it. |
| 71 | +- **Outdated resource?** Open an issue describing what's changed. |
| 72 | +- **Suggestion?** [Open a resource suggestion](../../issues/new?template=add-resource.yml). |
| 73 | + |
| 74 | +## Link Validation |
| 75 | + |
| 76 | +All links are automatically checked weekly via GitHub Actions. If a link is reported broken: |
| 77 | + |
| 78 | +1. We'll try to find an updated URL. |
| 79 | +2. If the resource is gone, it will be removed. |
| 80 | +3. Archived/read-only repos are acceptable if the content is still valuable. |
51 | 81 |
|
52 | | -### Removals |
| 82 | +## Removals |
53 | 83 |
|
54 | | -If a link is broken or a project is abandoned, open an issue or submit a PR to remove it. |
| 84 | +Resources may be removed if they: |
| 85 | +- Have a broken link that can't be fixed. |
| 86 | +- Are abandoned with no activity for 12+ months and no longer work. |
| 87 | +- Are superseded by a better alternative. |
| 88 | +- Violate our quality criteria. |
55 | 89 |
|
56 | 90 | ## Code of Conduct |
57 | 91 |
|
|
0 commit comments