Skip to content

Commit 6d822f0

Browse files
chore: switch to a less verbose PR template (#378)
the current PR template is too verbose and is a tad bit difficult to reason about. it includes unncessary checklist that do not fit the current contributing scope of this project anymore. in prior pull requests, you'll find people ignoring it. better to make it more concise than have a template that is of little to no use. this PR (#366) comment, is the approach i'm suggesting we take, going forward.
1 parent 132152f commit 6d822f0

1 file changed

Lines changed: 12 additions & 37 deletions

File tree

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 12 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,20 @@
11
## What does this PR do?
22

3-
<!-- Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. -->
3+
<!-- Brief description of the changes -->
44

5-
This PR [Fixes # (place issue number here without bracket)]
5+
## For project submissions
66

7-
<!-- Please provide a screenshots or upload a video for visual changes to speed up reviews -->
7+
If you're adding a new project, please confirm:
88

9-
## Type of change
10-
11-
<!-- Please mark the relevant points by using [x] -->
12-
13-
- [ ] Bug fix (non-breaking change which fixes an issue)
14-
- [ ] Chore (refactoring code, technical debt, workflow improvements)
15-
- [ ] Enhancement (small improvements)
16-
- [ ] New feature (non-breaking change which adds functionality)
17-
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
18-
- [ ] This change requires a documentation update
19-
20-
## How should this be tested?
21-
22-
<!-- Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. -->
23-
24-
- Test A
25-
- Test B
9+
- [ ] **Made in Nigeria** — created/maintained by a Nigerian developer
10+
- [ ] **Open source** — public repository with clear license
11+
- [ ] **Global use** — useful beyond just a Nigerian audience
12+
- **Stars** — at least 20 GitHub stars <enter your number of stars>
13+
- Author link: <!-- e.g., https://twitter.com/yourhandle or personal site -->
2614

2715
## Checklist
2816

29-
<!-- We're starting to get more and more contributions. Please help us making this efficient for all of us and go through this checklist. Please tick off what you did -->
30-
31-
### Required
32-
33-
- [ ] Filled out the "How to test" section in this PR
34-
- [ ] Self-reviewed my own code
35-
- [ ] Commented on my code in hard-to-understand bits
36-
- [ ] Ran `npm run build`
37-
- [ ] Checked for warnings, there are none
38-
- [ ] Removed all `console.logs`
39-
- [ ] Merged the latest changes from main onto my branch with `git pull origin main`
40-
- [ ] My changes don't cause any responsiveness issues
41-
42-
### Appreciated
43-
44-
- [ ] If a UI change was made: Added a screen recording or screenshots to this PR
45-
- [ ] Updated the Docs if changes were necessary
17+
- [ ] Self-reviewed my code
18+
- [ ] Ran `npm run build` (no errors)
19+
- [ ] Added screenshots/video (if UI changes)
20+
- [ ] Updated documentation (if needed)

0 commit comments

Comments
 (0)