You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/ISSUE_TEMPLATE/recommend-resource.yml
+38-24Lines changed: 38 additions & 24 deletions
Original file line number
Diff line number
Diff line change
@@ -10,26 +10,26 @@ body:
10
10
## Welcome! 👋
11
11
12
12
Thank you for recommending a resource to Awesome Claude Code! This form will guide you through the recommendation process.
13
-
Please make sure that you have already reviewed the CONTRIBUTING document as well as the CODE_OF_CONDUCT
13
+
Please make sure that you have already reviewed the CONTRIBUTING document as well as the CODE_OF_CONDUCT.
14
14
15
15
**Resource Guidelines:**
16
-
- Ensure that your resource is unique and provides genuine value to Claude Code users.
16
+
- Ensure that your resource is unique and provides genuine value to Claude Code users. (Review the existing resources before submitting.)
17
17
- Avoid submitting resources that violate the Claude Code Usage Policy (to the best of your understanding).
18
18
- Make sure that the project does not violate the licensing rights of other independent developers.
19
19
- Recommendations will be closely scrutinized for security and potential risk.
20
20
- Although most recommendations are submitted by the authors, you may submit any resource that you love.
21
21
22
22
**Tips and Tricks for a Speedy Review:**
23
23
- Please provide clear installation AND uninstallation instructions for any installable resources.
24
-
- Short examples or demos are tremendously helpful in the review process.
24
+
- If your resource requires me to execute a bash script, you **must** provide me with a clearly annotated/commented version in which everything is documented clearly. I _can_ read Bash, but it hurts my eyes after a while.
25
+
- Short examples or demos are tremendously helpful in the review process. If I can see it in action before I think about running it, you're way ahead of the curve.
25
26
- If your resource requires elevated access or "--dangerously-skip-permissions", please make sure the user is aware of this(!)
26
-
- If you are claiming that a resource improves Claude's capacity to perform some particular action - \
27
-
***provide clear instructions explaining how to demonstrate it.*** Instead of listing 100 things that your \
28
-
framework/plugin/etc. provides, better to pick one awesome thing it can do that makes it stand out, and explain how to validate that claim. \
29
-
That's not only helpful for me, but for anyone who is interested in your resource.
27
+
- If you are claiming that a resource improves Claude's capacity to perform some particular action - ***provide clear instructions explaining how to demonstrate it.*** Instead of listing 100 things that your framework/plugin/skill provides, better to pick one awesome thing it can do that makes it stand out, and explain how to validate that claim. That's not only helpful for me, but for any potential users.
30
28
31
-
After submission, our automated system will validate whether your Issue is well-formed with respect to the requirements of the template, \
32
-
and post the results as a comment. (This is merely a pre-requisite for being added.)
29
+
**Ask Claude for a Candid Review:**
30
+
When I review your recommendation, most likely I will ask my assistant Claude Code to give me its opinion as well. I might say: "Please give a careful review of this repository and evaluate it from 1-10 on the following aspects: (i) code quality; (ii) security; (iii) documentation; (iv) functionality. Finally, give an overall score and determine whether you would recommend this resource." Something like that. Do that. What you do after that is up to you, just be aware that this is something I will be doing as well.
31
+
32
+
After submission, our automated system will validate whether your Issue is well-formed with respect to the requirements of the template, and post the results as a comment. (This is merely a formality and does not constitute a review.)
33
33
34
34
- type: input
35
35
id: display_name
@@ -44,7 +44,7 @@ body:
44
44
id: category
45
45
attributes:
46
46
label: Category
47
-
description: Select the primary category for your resource
47
+
description: Select the primary category for your resource (note that I'm currenlty lumping most things called "plugins" under "Agent Skills" until I figure out a better classification system).
48
48
options:
49
49
- Agent Skills
50
50
- Workflows & Knowledge Guides
@@ -91,20 +91,11 @@ body:
91
91
validations:
92
92
required: true
93
93
94
-
- type: input
95
-
id: secondary_link
96
-
attributes:
97
-
label: Secondary Link
98
-
description: Optional additional link (e.g., documentation, npm package, website)
99
-
placeholder: "https://example.com/docs"
100
-
validations:
101
-
required: false
102
-
103
94
- type: input
104
95
id: author_name
105
96
attributes:
106
97
label: Author Name
107
-
description: "The author's name, alias, or GitHub username (You may submit public/open-source resources that you do not own.)"
98
+
description: "The author's name, alias, or GitHub username. (You may submit public/open-source resources that you do not own.)"
108
99
placeholder: "Jane Doe or janedoe"
109
100
validations:
110
101
required: true
@@ -122,7 +113,7 @@ body:
122
113
id: license
123
114
attributes:
124
115
label: License
125
-
description: Select the license for your resource (or choose 'Other' to specify)
116
+
description: Select the license for your resource (or choose 'Other' to specify something unlisted).
126
117
options:
127
118
- MIT
128
119
- Apache-2.0
@@ -159,15 +150,38 @@ body:
159
150
validations:
160
151
required: true
161
152
153
+
- type: markdown
154
+
attributes:
155
+
value: |
156
+
The following three fields are encouraged for all users. If you are recommending a plugin, skill, collection, framework, etc., then these are **mandatory**.
157
+
162
158
- type: textarea
163
159
id: validate_claims
164
160
attributes:
165
161
label: Validate Claims
166
-
description: "If you are submitting a complicated resource that gives Claude Code super-powers, suggest a low-friction way for me, or anyone, to prove it to themselves that what you're claiming is true."
162
+
description: "If you are submitting a complicated resource that gives Claude Code super-powers, suggest a low-friction way for me, or anyone, to prove it to themselves that what you're claiming is true. If you are submitting a plugin, skill, framework, or similar, this field is mandatory."
167
163
placeholder: "e.g., install this Skill and ask Claude how many times the letter 'r' appears in your codebase"
168
164
validations:
169
165
required: false
170
166
167
+
- type: textarea
168
+
id: validate_claim_part_2
169
+
attributes:
170
+
label: Specific Task(s)
171
+
description: "Tell me at least one specific task I should give to Claude Code to demonstrate the value of your resource."
172
+
placeholder: "e.g., install this Skill and give Claude a counting task."
173
+
validations:
174
+
required: false
175
+
176
+
- type: textarea
177
+
id: validate_claims_part_3
178
+
attributes:
179
+
label: Specific Prompt(s)
180
+
description: "Tell me what to say to Claude Code when I give it the task above. The more I have to figure things out for myself, the more likely it is that I will miss the unique value of your resource. So you are advised to be as specific as possible."
181
+
placeholder: "Ask Claude how many times the letter 'r' appears in your codebase"
182
+
validations:
183
+
required: false
184
+
171
185
- type: textarea
172
186
id: additional_comments
173
187
attributes:
@@ -199,8 +213,8 @@ body:
199
213
value: |
200
214
## What happens next?
201
215
202
-
1. **Automated Validation**: Our bot will validate the well-formed-ness of this Issue and comment with results
203
-
2. **Review**: If validation passes, a maintainer will review your recommendation as fast as possible given their available resources
216
+
1. **Automated Validation**: Our bot will validate the well-formed-ness of this Issue and let you know if anything needs to be fixed
217
+
2. **Review**: If validation passes, you should go back to working on your library - your recommendation has been received
204
218
3. **Approval**: If approved, a PR will be automatically created with your resource
205
219
4. **Notification**: You'll be notified when your resource is added
0 commit comments