Skip to content

Commit afbfa93

Browse files
docs: explain PR comment/re-review more explicitly (JoshuaKGoldberg#387)
## PR Checklist - [x] Addresses an existing open issue: fixes JoshuaKGoldberg#248 - [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 Brings in the latest-and-greatest typescript-eslint/typescript-eslint#6492 (i.e. typescript-eslint/typescript-eslint#6492).
1 parent 9cbecea commit afbfa93

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

.github/CONTRIBUTING.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Draft PRs won't be reviewed.
4343

4444
#### Granular PRs
4545

46-
Please keeep pull requests single-purpose: in other words, don't attempt to solve multiple unrelated problems in one pull request.
46+
Please keep pull requests single-purpose: in other words, don't attempt to solve multiple unrelated problems in one pull request.
4747
Send one PR per area of concern.
4848
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.
4949

@@ -55,6 +55,15 @@ A maintainer will look at it when they're next able to.
5555

5656
PRs should have passing [GitHub status checks](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks) before review is requested (unless there are explicit questions asked in the PR about any failures).
5757

58+
#### Asking Questions
59+
60+
If you need help and/or have a question, posting a comment in the PR is a great way to do so.
61+
There's no need to tag anybody individually.
62+
One of us will drop by and help when we can.
63+
64+
Please post comments as [line comments](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request) when possible, so that they can be threaded.
65+
You can [resolve conversations](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#resolving-conversations) on your own when you feel they're resolved - no need to comment explicitly and/or wait for a maintainer.
66+
5867
#### Requested Changes
5968

6069
After a maintainer reviews your PR, they may request changes on it.
@@ -64,6 +73,10 @@ Please try not to force-push commits to PRs that have already been reviewed.
6473
Doing so makes it harder to review the changes.
6574
We squash merge all commits so there's no need to try to preserve Git history within a PR branch.
6675

76+
Once you've addressed all our feedback by making code changes and/or started a followup discussion, [re-request review](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews#re-requesting-a-review) from each maintainer whose feedback you addressed.
77+
78+
Once all feedback is addressed and the PR is approved, we'll ensure the branch is up to date with `main` and merge it for you.
79+
6780
#### Post-Merge Recognition
6881

6982
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.

0 commit comments

Comments
 (0)