Skip to content

Commit 1c42f32

Browse files
hesreallyhimclaude
andauthored
Some fixes (#299)
* docs: update some docs * update readme * chore: cleanups * refactor: auto-lock override fields without explicit flags Simplified the resource override system by automatically locking any field set in resource-overrides.yaml, eliminating the need for manual *_locked flags and notes fields. Changes: - Updated apply_overrides() in validate_links.py, generate_readme.py, and download_resources.py to automatically lock fields when set - Removed all redundant *_locked flags from resource-overrides.yaml - Removed unused notes fields from resource-overrides.yaml - Updated documentation to reflect auto-locking behavior - Added verification tests confirming auto-lock functionality - Maintained skip_validation as highest precedence control flag Benefits: - Simpler, more intuitive YAML configuration - Less redundancy and cleaner override declarations - Backwards compatible with legacy *_locked flags (ignored gracefully) - Consistent behavior across all scripts All 82 existing tests pass, plus new verification tests confirm the refactored system works correctly. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]> * chore: tests * fix: remove broken links * chore: cleanup * announcements etc --------- Co-authored-by: Claude <[email protected]>
1 parent afab1ad commit 1c42f32

16 files changed

+478
-457
lines changed

CONTRIBUTING.md

Lines changed: 24 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@ Welcome! We're excited that you want to contribute to Awesome Claude Code. This
44

55
**Important:** We take security seriously. All submissions are carefully reviewed to ensure they don't expose users to data risks or malicious code. Advanced tools may take additional time to review.
66

7+
> [!IMPORTANT]
8+
> Due to resource limitations, you may experience some delays in getting a review from a maintainer. We appreciate your patience.
9+
710
## Code of Conduct
811

912
Please note that this project is released with a [Contributor Code of Conduct](code-of-conduct.md). By participating in this project you agree to abide by its terms. Follow the conventions of the repo and don't engage in self-promotion. Use descriptive language, not "marketing" style.
@@ -46,7 +49,8 @@ When you submit a resource, our bot checks:
4649
- ✅ License information (when available)
4750
- ✅ Description length and quality
4851

49-
**NOTE:** By submitting a resource, you agree to allowing your codebase to be evaluated by a SoTA LLM for any security risks.
52+
> [!NOTE]
53+
> The automated validation process is to ensure that the **format of your submission** conforms to the required format for the project's CI/CI - it is a preliminary check and does not indicate anything about the quality of the resource, or whether it will get added to the list.
5054
5155
### If Changes Are Needed
5256

@@ -56,13 +60,13 @@ Don't worry if validation fails! The bot will:
5660
2. Update the issue labels to reflect the status
5761
3. Re-validate automatically when you edit your submission
5862

59-
Simply edit your issue to fix any problems - no need to create a new submission.
63+
Simply edit your issue to fix any problems - no need to create a new submission. If you are getting "stuck" or the bot is not working correctly, feel free to ping @hesreallyhim.
6064

6165
### Approval Process
6266

6367
Once validation passes:
6468

65-
1. A maintainer will review your submission for quality and relevance
69+
1. A maintainer will review your submission for inclusion in the list (this is done _as time permits_).
6670
2. They may:
6771
-**Approve** - Type `/approve` and the bot creates a PR
6872
- 🔄 **Request changes** - Type `/request-changes` with feedback
@@ -89,7 +93,7 @@ Your submission should:
8993
- 🚀 Demonstrate innovative or exemplary usage patterns
9094
- 📚 Follow best practices for the resource type
9195
- 🔄 Work with the latest version of Claude Code
92-
- 📝 Include clear documentation (demo videos are a huge bonus!)
96+
- 📝 Include clear documentation (**demo videos are a huge bonus!**)
9397
- ❄️ Be unique and different from other existing awesome resources
9498
- ⚖️ Respect the Terms of Service that govern the usage of Claude Code
9599

@@ -104,12 +108,15 @@ We especially welcome:
104108

105109
Resources are organized into these categories:
106110

111+
- **Agent Skills** - Individual skill files or folders that give Claude super-powers.
107112
- **Workflows & Knowledge Guides** - Comprehensive workflow systems
108113
- **Tooling** - CLI applications and executables
109114
- IDE Integrations
115+
- Usage Monitors
116+
- Orchestrators
110117
- **Status Lines** - Status bar configurations and customizations
111118
- **Hooks** - Claude Code hook configurations
112-
- **Output Styles** - Configurations for customizing Claude Code's output formatting
119+
- **Output Styles** - Configurations for customizing Claude Code's output formatting (**Soon to be deprecated**)
113120
- **Slash-Commands** - Individual command files
114121
- Version Control & Git
115122
- Code Analysis & Testing
@@ -122,49 +129,8 @@ Resources are organized into these categories:
122129
- Language-Specific
123130
- Domain-Specific
124131
- Project Scaffolding & MCP
132+
- **Alternative Clients** - Alternative front-ends and interfaces for using Claude Code (e.g. mobile apps).
125133
- **Official Documentation** - Anthropic resources
126-
- **Alternative Clients** - Alternative implementations and interfaces for Claude
127-
128-
## Adding New Categories
129-
130-
Repository maintainers can add new categories using the automated tool:
131-
132-
### Interactive Mode
133-
```bash
134-
make add-category
135-
```
136-
137-
This will prompt you for:
138-
- Category name
139-
- ID and prefix
140-
- Icon emoji
141-
- Description
142-
- Order position
143-
- Subcategories
144-
145-
### Command Line Mode
146-
```bash
147-
make add-category ARGS='--name "My Category" --prefix "mycat" --icon "🎯"'
148-
```
149-
150-
### What It Does
151-
The `add-category` command automatically:
152-
1. Updates `templates/categories.yaml` with the new category
153-
2. Updates the GitHub issue template dropdown
154-
3. Regenerates the README with the new section
155-
4. Optionally creates a commit with all changes
156-
157-
### Examples
158-
```bash
159-
# Add a simple category with defaults
160-
make add-category ARGS='--name "Extensions" --prefix "ext" --icon "🧩"'
161-
162-
# Add a category with multiple subcategories
163-
make add-category ARGS='--name "Integrations" --prefix "int" --icon "🔗" --subcategories "API,Webhooks,Plugins"'
164-
165-
# Add a category at a specific position
166-
make add-category ARGS='--name "Templates" --prefix "tmpl" --icon "📋" --order 5'
167-
```
168134

169135
## Best Practices
170136

@@ -184,12 +150,22 @@ For suggestions about the repository structure, new categories, or other enhance
184150
2. Describe your suggestion clearly
185151
3. Explain the benefit to the community
186152

153+
Or, alternatively, start a thread in the [Discussions](https://github.com/hesreallyhim/awesome-claude-code/discussions) tab.
154+
155+
## How Can I Get the Maintainer to Prioritize my Resource?
156+
157+
Although we cannot make any guarantees at the moment, here are some tips:
158+
159+
- Make it **as easy as possible** to understand, verify the security of, install, test-drive, and uninstall your resource. Naturally, if you submit a complicated framework (however awesome it may be) that takes continued usage to demonstrate its value, this will be more difficult to appraise and recommend.
160+
- **Participate in the Discussions** - Maintainers are much more likely to engage with users who are engaged with this repository as a community resource - participating in Discussions shows that you want to be help contribute to this _community_, rather than "only" a list.
161+
- Feel free to **comment on other submissions** (respectfully of course) - if we see that there is a lot of community interest in a particular resource, this is a strong signal that it should be added to the list.
162+
187163
### Reporting Issues
188164

189165
If you find problems with existing resources or the submission process:
190166

191167
- 📖 Check existing issues for similar reports
192-
- 💬 Open a new issue with details
168+
- 💬 Open a new General Issue with details
193169
- 🐛 Include error messages and steps to reproduce
194170
- 🔒 Report security issues immediately
195171

DONTREADME.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

HOW_IT_WORKS.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -301,6 +301,47 @@ python scripts/generate_readme.py
301301
ISSUE_BODY="..." python scripts/parse_issue_form.py --validate
302302
```
303303

304+
## Adding New Categories
305+
306+
Repository maintainers can add new categories using the automated tool:
307+
308+
### Interactive Mode
309+
```bash
310+
make add-category
311+
```
312+
313+
This will prompt you for:
314+
- Category name
315+
- ID and prefix
316+
- Icon emoji
317+
- Description
318+
- Order position
319+
- Subcategories
320+
321+
### Command Line Mode
322+
```bash
323+
make add-category ARGS='--name "My Category" --prefix "mycat" --icon "🎯"'
324+
```
325+
326+
### What It Does
327+
The `add-category` command automatically:
328+
1. Updates `templates/categories.yaml` with the new category
329+
2. Updates the GitHub issue template dropdown
330+
3. Regenerates the README with the new section
331+
4. Optionally creates a commit with all changes
332+
333+
### Examples
334+
```bash
335+
# Add a simple category with defaults
336+
make add-category ARGS='--name "Extensions" --prefix "ext" --icon "🧩"'
337+
338+
# Add a category with multiple subcategories
339+
make add-category ARGS='--name "Integrations" --prefix "int" --icon "🔗" --subcategories "API,Webhooks,Plugins"'
340+
341+
# Add a category at a specific position
342+
make add-category ARGS='--name "Templates" --prefix "tmpl" --icon "📋" --order 5'
343+
```
344+
304345
## Maintenance Tasks
305346

306347
### Regular Tasks

0 commit comments

Comments
 (0)