Skip to content

Commit 5e8a25e

Browse files
vintaclaude
andcommitted
Reorganize CONTRIBUTING.md for better clarity
Move "Automatic Rejection" section to top of document as first-line filter for reviewers. Consolidate duplicate rejection criteria from "Common Mistakes" and bottom "Automatic Rejection" sections into single comprehensive list. Reorder remaining sections in logical flow: rejections, quality requirements, acceptance criteria, format reference, review process. 🤖 Generated with Claude Code (https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 163dab2 commit 5e8a25e

1 file changed

Lines changed: 24 additions & 47 deletions

File tree

CONTRIBUTING.md

Lines changed: 24 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,28 @@
11
# Contributing
22

3-
## Quick Checklist
3+
## Automatic Rejection
44

5-
Before submitting a PR, verify:
5+
PRs will be **closed** if:
66

7-
- [ ] One link per Pull Request
8-
- [ ] PR title format: `Add project-name`
9-
- [ ] Entry format: `* [project-name](url) - A short description ending with a period.`
10-
- [ ] Description is concise (one sentence)
11-
- [ ] Placed in the appropriate category/subcategory
12-
- [ ] No trailing whitespace
13-
- [ ] Spelling and grammar checked
7+
- Adding multiple projects in one PR
8+
- Duplicate of existing entry or recently-closed PR
9+
- Empty or placeholder PR descriptions
10+
- Placed under an inappropriate category
11+
- Project is archived or abandoned (no commits in 12+ months)
12+
- No documentation or unclear use case
13+
- Less than 100 GitHub stars without Hidden Gem justification
14+
- Repository less than 3 months old
15+
16+
## Quality Requirements
17+
18+
All submissions must satisfy **ALL** of these:
19+
20+
1. **Python-first**: Primarily written in Python (>50% of codebase)
21+
2. **Active**: Commits within the last 12 months
22+
3. **Stable**: Production-ready, not alpha/beta/experimental
23+
4. **Documented**: Clear README with examples and use cases
24+
5. **Unique**: Adds distinct value, not "yet another X"
25+
6. **Established**: Repository at least 1 month old
1426

1527
## Acceptance Criteria
1628

@@ -31,21 +43,13 @@ Your submission must meet **ONE** of the following criteria:
3143

3244
### 3. Hidden Gem
3345

34-
- Exceptional quality despite fewer stars (may have <500 stars)
46+
- Exceptional quality despite fewer stars (100-500 stars preferred; < 100 requires strong justification)
3547
- Solves niche problems elegantly
3648
- Strong recommendation from experienced developers
49+
- **Must demonstrate real-world usage** (not a project published last week)
50+
- Repository must be at least 6 months old with consistent activity
3751
- Must include compelling justification in PR description
3852

39-
## Quality Requirements
40-
41-
All submissions must satisfy **ALL** of these:
42-
43-
1. **Python-first**: Primarily written in Python (>50% of codebase)
44-
2. **Active**: Commits within the last 12 months
45-
3. **Stable**: Production-ready, not alpha/beta/experimental
46-
4. **Documented**: Clear README with examples and use cases
47-
5. **Unique**: Adds distinct value, not "yet another X"
48-
4953
## Entry Format Reference
5054

5155
### Standard Entry
@@ -82,26 +86,10 @@ All submissions must satisfy **ALL** of these:
8286

8387
## Adding a New Section
8488

85-
If adding a new category:
86-
8789
1. Add section description in italics: `*Libraries for doing X.*`
8890
2. Add the section title to the Table of Contents
8991
3. Keep sections in alphabetical order
9092

91-
## PR Description Template
92-
93-
Please include the following in your PR description:
94-
95-
```
96-
## Why This Project Is Awesome
97-
98-
[Explain which criterion it meets: Industry Standard / Rising Star / Hidden Gem]
99-
100-
## How It Differs
101-
102-
[If similar entries exist, explain what makes this one unique]
103-
```
104-
10593
## Review Process
10694

10795
PRs are reviewed by automated tools and maintainers:
@@ -113,14 +101,3 @@ PRs are reviewed by automated tools and maintainers:
113101
5. **Quality Check**: Meets acceptance criteria
114102

115103
Search previous Pull Requests and Issues before submitting, as yours may be a duplicate.
116-
117-
## Automatic Rejection
118-
119-
PRs will be **closed** if:
120-
121-
- Add more than one project per PR
122-
- Duplicate of existing entry
123-
- Placed under an inappropriate category
124-
- Project is archived or abandoned (no commits in 12+ months)
125-
- No documentation or unclear use case
126-
- Less than 100 GitHub stars AND not justified as a hidden gem

0 commit comments

Comments
 (0)