Skip to content

Commit

Permalink
docs(contributing): 📝 update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
- Add a section on Granular PRs to Sending Contributions
- Add additional context and guidelines to Pull Request Reviews.
- Clarify the process for addressing requested changes in PRs
- Update contributor recognition process to reflect current practices
  • Loading branch information
navin-moorthy committed May 4, 2023
1 parent 7005e6a commit da65ce1
Showing 1 changed file with 47 additions and 5 deletions.
52 changes: 47 additions & 5 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,11 @@ Thanks for your interest in contributing to `node-ts-app`! 💖
- [Finding an Issue](#finding-an-issue)
- [Sending a Pull Request](#sending-a-pull-request)
- [Draft PRs](#draft-prs)
- [Granular PRs](#granular-prs)
- [Pull Request Reviews](#pull-request-reviews)
- [Asking Questions](#asking-questions)
- [Requested Changes](#requested-changes)
- [Post-Merge Recognition](#post-merge-recognition)

## Code of Conduct

Expand Down Expand Up @@ -61,23 +65,56 @@ this wrong: you can always change the PR title after sending it. Check
If you don't think your PR is ready for review, [set it as a draft][9]. Draft
PRs won't be reviewed.

#### Granular PRs

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

#### Pull Request Reviews

When a PR is not in draft, it's considered ready for review. Please don't
manually `@` tag anybody to request review. A maintainer will look at it when
they're next able to.

PRs should have passing [GitHub status checks][13] before review is requested
(unless there are explicit questions asked in the PR about any failures).

#### Asking Questions

If you need help and/or have a question, posting a comment in the PR is a great
way to do so. There's no need to tag anybody individually. One of us will drop
by and help when we can.

Please post comments as [line comments][14] when possible, so that they can be
threaded. You can [resolve conversations][15] on your own when you feel they're
resolved - no need to comment explicitly and/or wait for a maintainer.

#### Requested Changes

After a maintainer reviews your PR, they may request changes on it. Once you've
made those changes, [re-request review on GitHub][10].

Please try not to force-push commits to PRs that have already been reviewed.
Doing so makes it harder to review the changes. We squash merge all commits so
there's no need to try to preserve Git history within a PR branch.

Once your PR is merged, if you haven't yet been added to the [_Contributors_
table in the README.md][11] for its [type of contribution][12], you should be
soon. 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!
Once you've addressed all our feedback by making code changes and/or started a
followup discussion, [re-request review][10] from each maintainer whose feedback
you addressed.

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.

#### Post-Merge Recognition

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][12], you should be soon. 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!

[1]: ./DEVELOPMENT.md
[2]: ./CODE_OF_CONDUCT.md
Expand All @@ -94,5 +131,10 @@ within 24 hours - it was likely an oversight on our end!
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
[10]:
https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews#re-requesting-a-review
[11]: ../README.md#contributors
[12]: https://allcontributors.org/docs/en/emoji-key "Allcontributors emoji key"
[13]:
https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks
[14]:
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
[15]:
https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#resolving-conversations

0 comments on commit da65ce1

Please sign in to comment.