Skip to content

Commit e2fd883

Browse files
docs: mention granular PRs in CONTRIBUTING.md (#354)
## PR Checklist - [x] Addresses an existing open issue: fixes #350 - [x] That issue was marked as [`status: accepting prs`](https://github.com/JoshuaKGoldberg/template-typescript-node-package/issues?q=is%3Aopen+is%3Aissue+label%3A%22status%3A+accepting+prs%22) - [x] Steps in [CONTRIBUTING.md](https://github.com/JoshuaKGoldberg/template-typescript-node-package/blob/main/.github/CONTRIBUTING.md) were taken ## Overview Slightly reorganizes the headings to make the sub-sections more distinct.
1 parent 1e29b61 commit e2fd883

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

.github/CONTRIBUTING.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,12 @@ Check [previously merged PRs](https://github.com/JoshuaKGoldberg/template-typesc
4141
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).
4242
Draft PRs won't be reviewed.
4343

44+
#### Granular PRs
45+
46+
Please keeep pull requests single-purpose: in other words, don't attempt to solve multiple unrelated problems in one pull request.
47+
Send one PR per area of concern.
48+
Multi-purpose pull requests are harder and slower to review, block all changes from being merged until the whole pull request is reviewed, and are difficult to name well with semantic PR titles.
49+
4450
#### Pull Request Reviews
4551

4652
When a PR is not in draft, it's considered ready for review.
@@ -54,5 +60,7 @@ Please try not to force-push commits to PRs that have already been reviewed.
5460
Doing so makes it harder to review the changes.
5561
We squash merge all commits so there's no need to try to preserve Git history within a PR branch.
5662

63+
#### Post-Merge Recognition
64+
5765
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.
5866
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)