Skip to content

Commit dc5e14d

Browse files
authored
Fix awesome ticker; better issue template
Fix awesome ticker; better issue template
2 parents e6c0174 + 445b14a commit dc5e14d

File tree

2 files changed

+39
-25
lines changed

2 files changed

+39
-25
lines changed

.github/ISSUE_TEMPLATE/recommend-resource.yml

Lines changed: 38 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -10,26 +10,26 @@ body:
1010
## Welcome! 👋
1111
1212
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.
1414
1515
**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.)
1717
- Avoid submitting resources that violate the Claude Code Usage Policy (to the best of your understanding).
1818
- Make sure that the project does not violate the licensing rights of other independent developers.
1919
- Recommendations will be closely scrutinized for security and potential risk.
2020
- Although most recommendations are submitted by the authors, you may submit any resource that you love.
2121
2222
**Tips and Tricks for a Speedy Review:**
2323
- 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.
2526
- 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.
3028
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.)
3333
3434
- type: input
3535
id: display_name
@@ -44,7 +44,7 @@ body:
4444
id: category
4545
attributes:
4646
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).
4848
options:
4949
- Agent Skills
5050
- Workflows & Knowledge Guides
@@ -91,20 +91,11 @@ body:
9191
validations:
9292
required: true
9393

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-
10394
- type: input
10495
id: author_name
10596
attributes:
10697
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.)"
10899
placeholder: "Jane Doe or janedoe"
109100
validations:
110101
required: true
@@ -122,7 +113,7 @@ body:
122113
id: license
123114
attributes:
124115
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).
126117
options:
127118
- MIT
128119
- Apache-2.0
@@ -159,15 +150,38 @@ body:
159150
validations:
160151
required: true
161152

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+
162158
- type: textarea
163159
id: validate_claims
164160
attributes:
165161
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."
167163
placeholder: "e.g., install this Skill and ask Claude how many times the letter 'r' appears in your codebase"
168164
validations:
169165
required: false
170166

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+
171185
- type: textarea
172186
id: additional_comments
173187
attributes:
@@ -199,8 +213,8 @@ body:
199213
value: |
200214
## What happens next?
201215
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
204218
3. **Approval**: If approved, a PR will be automatically created with your resource
205219
4. **Notification**: You'll be notified when your resource is added
206220

.github/workflows/update-repo-ticker.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,5 +54,5 @@ jobs:
5454
run: |
5555
git config --local user.email "github-actions[bot]@users.noreply.github.com"
5656
git config --local user.name "github-actions[bot]"
57-
git add data/repo-ticker.csv data/repo-ticker-previous.csv assets/repo-ticker.svg assets/repo-ticker-light.svg
57+
git add data/repo-ticker.csv data/repo-ticker-previous.csv assets/repo-ticker.svg assets/repo-ticker-light.svg assets/repo-ticker-awesome.svg
5858
git diff --quiet && git diff --staged --quiet || (git commit -m "chore: update repo ticker data and SVGs [skip ci]" && git push)

0 commit comments

Comments
 (0)