Skip to content

Instantly share code, notes, and snippets.

@mtucker

mtucker/pr-comments.md

Forked from erickrawczyk/pr-comments.md
Last active October 19, 2023 18:06
Show Gist options
  • Save mtucker/96794274f9d8dad484c4cfa3593063ef to your computer and use it in GitHub Desktop.
Save mtucker/96794274f9d8dad484c4cfa3593063ef to your computer and use it in GitHub Desktop.
Download ZIP
PR Comments with a Purpose
Raw
pr-comments.md

This is a set of ‘statuses’ that pull request comments must be marked with to help explain intent.

  • Required: This must be fixed before merge.
  • Nice to have: Would be great to fix eventually.
  • Personal Preference: I would do this, but you don’t have to.
  • Question: Point of clarification?
  • Potential Alternative: Presenting an alternative approach in order to invite discussion.
  • Suggested Change: I have pushed a set of changes that I want to call out.

Modified from Scaling Square Register on objc.io

Raw
setup.md

Creating Saved Replies

Navigate to your GitHub Saved Replies and add new saved replies with the following templates. You're welcome to use this gist or fork it and use your own.

Example
image

PR: Nice to Have

**Nice to Have** <sup>[What's this?](https://gist.github.com/erickrawczyk/28c30ab880eae3b275c542915ba44d8a)</sup>

PR: Personal Preference

**Personal Preference** <sup>[What's this?](https://gist.github.com/erickrawczyk/28c30ab880eae3b275c542915ba44d8a)</sup>

PR: Question

**Question** <sup>[What's this?](https://gist.github.com/erickrawczyk/28c30ab880eae3b275c542915ba44d8a)</sup>

PR: Required

**Required** (this blocker must be fixed before merge) <sup>[What's this?](https://gist.github.com/erickrawczyk/28c30ab880eae3b275c542915ba44d8a)</sup>

PR: Suggested Change

**Suggested Change** <sup>[What's this?](https://gist.github.com/erickrawczyk/28c30ab880eae3b275c542915ba44d8a)</sup>

Before/After

| **Before** | **After**|
|-|-|
| paste_before_here | paste_after_here |

Using Saved Replies

When creating an inline comment in a PR, click the image button and select your saved reply from the popover.

Step Example
Click the Reply button image
Select your reply to autofill image
Enter your comment image
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment