Skip to content

Commit 5d6a002

Browse files
Copilotashleywolf
Copilot
and
ashleywolf
committed
Expand CONTRIBUTING.md and add PR template with checklist
Co-authored-by: ashleywolf <[email protected]>
1 parent a881ecf commit 5d6a002

File tree

2 files changed

+117
-0
lines changed

2 files changed

+117
-0
lines changed

‎.github/pull_request_template.md‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
## Description
2+
3+
<!-- Briefly describe what this PR adds or changes -->
4+
5+
## Type of Change
6+
7+
<!-- Check all that apply -->
8+
9+
- [ ] Adding a new tool/project
10+
- [ ] Adding a new category
11+
- [ ] Updating an existing entry
12+
- [ ] Fixing a broken link
13+
- [ ] Documentation update
14+
- [ ] Other (please describe):
15+
16+
## For New Tools/Projects
17+
18+
<!-- If you're adding a new tool or project, please complete this section -->
19+
20+
### Why is this tool/project needed?
21+
22+
<!-- Explain the problem it solves or the gap it fills. How does it help organizations manage open source projects or OSPOs? -->
23+
24+
### Category Selection
25+
26+
**Selected Category:** <!-- e.g., Code Reviews, GitHub Management, etc. -->
27+
28+
**Why this category?**
29+
30+
<!-- Explain why you chose this specific category. If the tool fits multiple categories, explain why this is the primary use case. -->
31+
32+
### Tool Uniqueness
33+
34+
<!-- If similar tools already exist in the list, explain what makes this tool unique or complementary -->
35+
36+
## For New Categories
37+
38+
<!-- If you're proposing a new category, please complete this section -->
39+
40+
### Why is a new category needed?
41+
42+
<!-- Explain what gap the new category would fill -->
43+
44+
### Example Tools
45+
46+
<!-- Provide at least 2-3 examples of tools that would fit in this category -->
47+
48+
1.
49+
2.
50+
3.
51+
52+
### Category Positioning
53+
54+
<!-- Suggest where the new category should be positioned in the list -->
55+
56+
### Why existing categories are not suitable
57+
58+
<!-- Explain why existing categories don't work for these tools -->
59+
60+
## Checklist
61+
62+
<!-- Check all that apply -->
63+
64+
- [ ] I have read the [CONTRIBUTING.md](../CONTRIBUTING.md) guidelines
65+
- [ ] I have searched for duplicate suggestions
66+
- [ ] The pull request has a descriptive title
67+
- [ ] I have added the entry to the bottom of the relevant category (if adding a new tool)
68+
- [ ] I have checked my spelling and grammar
69+
- [ ] I have removed trailing whitespace
70+
- [ ] I have verified that all links work correctly
71+
- [ ] I have provided context on why this change is needed (above)

‎CONTRIBUTING.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,56 @@
22

33
We welcome improvements and suggestions! Please consider these guidelines:
44

5+
## General Guidelines
6+
57
- Make an individual pull request for each suggestion.
68
- The pull request and commit should have a useful title.
79
- Search previous suggestions before making a new one, as yours may be a duplicate.
810
- New links should be added to the bottom of their relevant category.
911
- New categories or improvements to the existing categorization are welcome.
1012
- Make sure your text editor is set to remove trailing whitespace.
1113
- Check your spelling and grammar.
14+
15+
## Adding a New Tool or Project
16+
17+
When submitting a new tool or project, please provide context to help reviewers understand your suggestion:
18+
19+
### Why is this tool/project needed?
20+
- Explain the problem it solves or the gap it fills in the current list
21+
- Describe how it helps organizations manage open source projects or OSPOs
22+
- If similar tools exist in the list, explain what makes this tool unique or complementary
23+
24+
### Choosing the Right Category
25+
26+
Our list includes the following categories:
27+
- **Code Reviews** - Tools for managing and automating code review processes
28+
- **Continuous Integration / Continuous Delivery** - CI/CD platforms and tools
29+
- **Contributor License Agreements / Developer Certificate of Origins** - CLA and DCO management tools
30+
- **GitHub Metrics and Dashboards** - Tools for tracking and visualizing GitHub activity
31+
- **GitHub Management** - Tools for managing GitHub organizations and repositories
32+
- **Governance** - Tools for project governance and community management
33+
- **Project Quality** - Tools for assessing and improving project quality
34+
- **Supply Chain Trust** - Tools for managing software supply chain security
35+
- **Licensing** - Tools for managing and tracking open source licenses
36+
- **Localization and Internationalization** - Tools for managing translations and i18n
37+
- **Websites and Documentation** - Tools for creating and managing project websites and documentation
38+
- **Security** - Security scanning and vulnerability management tools
39+
- **In-Kind Donations** - Resources for in-kind donations and support programs
40+
41+
When adding a new tool:
42+
1. Review the category descriptions above
43+
2. Select the category that best fits the tool's primary purpose
44+
3. If the tool fits multiple categories, choose the one that represents its main use case
45+
4. In your pull request, explain why you chose that specific category
46+
47+
### Proposing a New Category
48+
49+
If you believe a new category is needed:
50+
1. Explain what gap the new category would fill
51+
2. Provide at least 2-3 examples of tools that would fit in this category
52+
3. Suggest where the new category should be positioned in the list
53+
4. Explain why existing categories are not suitable for these tools
54+
55+
## Pull Request Template
56+
57+
When creating a pull request, please fill out the PR template completely. This helps maintainers review your contribution more efficiently and makes the review process smoother for everyone.

0 commit comments

Comments
 (0)