Skip to content

Instantly share code, notes, and snippets.

Last active June 14, 2024 11:49
Show Gist options
  • Save ifyoumakeit/4148a8c3e61b7868935651272c03f793 to your computer and use it in GitHub Desktop.
Save ifyoumakeit/4148a8c3e61b7868935651272c03f793 to your computer and use it in GitHub Desktop.
GitHub Conventional Comments (instructions to install in comment below code)
(async function generateReplies(document) {
const LABEL = {
praise: "praise",
nitpick: "nitpick",
suggestion: "suggestion",
issue: "issue",
todo: "todo",
question: "question",
thought: "thought",
chore: "chore",
typo: "typo",
polish: "polish",
quibble: "quibble",
note: "note"
const NON_BLOCKING = [LABEL.nitpick, LABEL.thought, LABEL.quibble, LABEL.note];
const COMMENT = {
"Praises highlight something positive. Try to leave at least one of these comments per review. Do not leave false praise (which can actually be damaging). Do look for something to sincerely praise.",
"Nitpicks are trivial preference-based requests. These should be non-blocking by nature.",
"Suggestions propose improvements to the current subject. It's important to be explicit and clear on what is being suggested and why it is an improvement. Consider using patches and the blocking or non-blocking decorations to further communicate your intent.",
"Issues highlight specific problems with the subject under review. These problems can be user-facing or behind the scenes. It is strongly recommended to pair this comment with a suggestion. If you are not sure if a problem exists or not, consider leaving a question.",
"TODO's are small, trivial, but necessary changes. Distinguishing todo comments from issues: or suggestions: helps direct the reader's attention to comments requiring more involvement.",
"Questions are appropriate if you have a potential concern but are not quite sure if it's relevant or not. Asking the author for clarification or investigation can lead to a quick resolution.",
"Thoughts represent an idea that popped up from reviewing. These comments are non-blocking by nature, but they are extremely valuable and can lead to more focused initiatives and mentoring opportunities.",
"Chores are simple tasks that must be done before the subject can be “officially” accepted. Usually, these comments reference some common process. Try to leave a link to the process description so that the reader knows how to resolve the chore.",
"Notes are always non-blocking and simply highlight something the reader should take note of.",
"Typo comments are like todo:, where the main issue is a mispelling.",
"Polish comments are like a suggestion, where there is nothing necessarily wrong with the relevant content, there's just some ways to immediately improve the quality.",
"Quibbles are very much like nitpick:, except it does not conjure up images of lice and animal hygiene practices.",
function post(key, token) {
const blockingText = NON_BLOCKING.includes(key) ? " (non-blocking)" : "";
return fetch("replies", {
headers: { "content-type": "application/x-www-form-urlencoded" },
method: "POST",
mode: "cors",
credentials: "include",
body: new URLSearchParams({
body: `<!-- ${COMMENT[key]} -->\n**${key}${blockingText}:** ‏`,
authenticity_token: token,
title: `${key[0].toUpperCase()}${key.slice(1)}${blockingText}`,
const form = document.querySelector(".new_saved_reply");
const token = form.querySelector("[name=authenticity_token]").value;
// Replies are order alphabetically, so order doesn't need to preserved.
await Promise.all(Object.keys(LABEL).map(key => post(key, token)));
console.log("All added! Refresh the page!");
Copy link

ifyoumakeit commented Aug 6, 2020

GitHub Conventional Comments!

Conventional Comments is a standard for formatting comments of any kind of review/feedback process. GitHub Saved Replies are re-usable text snippets that you can use throughout GitHub comment fields. Combining the two gives you GitHub Conventional Comments!

How to install

  1. Go to
  2. Open Developer Tools
  3. Paste and run above code in JavaScript console

How to add a conventional comment

Go to a Pull Request or Issue comment box and press CTRL + . or click reply button.

Note: doesn't work in gists.

Copy link

ifyoumakeit commented Aug 7, 2020



Copy link

GZLiew commented Dec 14, 2022

Amazing snippet!

Copy link


Copy link


Copy link

**nitpick (non-blocking, if-minor);

Copy link

Updated to add todo, polish, quibble and typo.

Copy link

Added note and some non-blocking tags for those that always non-blocking.

Copy link

@ifyoumakeit something about the non_blocking made these specific ones return undefined

Copy link

@miketheman so fast! I forgot that I was using the LABELS as a lookup. It's fixed.

Copy link

@ifyoumakeit excellent, thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment