Skip to content

Commit ffbea3d

Browse files
docs: describe PR review flow (#314)
1 parent 2724382 commit ffbea3d

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

.github/CONTRIBUTING.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,23 @@ Only PR titles need to be in that format, not individual commits.
3636
Don't worry if you get this wrong: you can always change the PR title after sending it.
3737
Check [previously merged PRs](https://github.com/JoshuaKGoldberg/template-typescript-node-package/pulls?q=is%3Apr+is%3Amerged+-label%3Adependencies+) for reference.
3838

39+
#### Draft PRs
40+
41+
If you don't think your PR is ready for review, [set it as a draft](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request#converting-a-pull-request-to-a-draft).
42+
Draft PRs won't be reviewed.
43+
44+
#### Pull Request Reviews
45+
46+
When a PR is not in draft, it's considered ready for review.
47+
Please don't manually `@` tag anybody to request review.
48+
A maintainer will look at it when they're next able to.
49+
50+
After a maintainer reviews your PR, they may request changes on it.
51+
Once you've made those changes, [re-request review on GitHub](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews#re-requesting-a-review).
52+
3953
Please try not to force-push commits to PRs that have already been reviewed.
4054
Doing so makes it harder to review the changes.
4155
We squash merge all commits so there's no need to try to preserve Git history within a PR branch.
56+
57+
Once your PR is merged, if you haven't yet been added to the [_Contributors_ table in the README.md](../README.md#contributors) for its [type of contribution](https://allcontributors.org/docs/en/emoji-key "Allcontributors emoji key"), you should be soon.
58+
Please do ping the maintainer who merged your PR if that doesn't happen within 24 hours - it was likely an oversight on our end!

0 commit comments

Comments
 (0)