Skip to content

add PR Checklist #39

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kbinreallife merged 3 commits into from
Dec 31, 2024
Merged

add PR Checklist #39

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7b716a0
Update CONTRIBUTING.md
seanmakesgames Dec 21, 2024
8c29409
Update CONTRIBUTING.md
seanmakesgames Dec 22, 2024
8c87454
Update CONTRIBUTING.md
kbinreallife Dec 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,3 +110,17 @@ In general, reviewers are acting in the role of maintainers in the open-source m
1. Share non-blocking improvement feedback
1. Things like typos, spelling errors, capitalization, rephrasing (Depending on repo-specific styles some of these might be required)
1. Ask questions for reviewer's own understanding & learning

#### The reviewer checklist

A reviewer's job is to ensure that the answer to all these questions is 'yes'. Only then should a PR be approved.

- [ ] Does the PR have a problem statement that is clear and for an existing agreed upon quality bar? (subjective: typos, color strings, etc)
- [ ] Does this PR have an issue associated with it?
- [ ] Was the issue triaged?
- [ ] Does the PR fix only the issue or problem statement described in the simplest way? (subjective)
- [ ] Does the PR have sufficient test coverage? (subjective: does it need tests? do they exist? are they in the pr?)
- [ ] Have manual testing requirements been done? (e.g. hackmudclient needs manual testing on windows)
- [ ] Does any documentation need to be updated or created?
- [ ] Is a migration required for this change? (e.g. marks schema migration, account or user schema migration)
- [ ] Was all debugging output code removed from the change?
Loading