Skip to content

Instantly share code, notes, and snippets.

Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save harrism/a206a22012df3f29e518066d015df4d5 to your computer and use it in GitHub Desktop.
Save harrism/a206a22012df3f29e518066d015df4d5 to your computer and use it in GitHub Desktop.
GitHub Conventional Comments (instructions to install in comment below code)
(async function generateReplies(document) {
// https://conventionalcomments.org/#labels
const LABEL = {
praise: "👏 praise",
nitpick: "🤓 nitpick",
suggestion: "💡 suggestion",
issue: "🚩 issue",
todo: "☑️ todo",
question: "❓ question",
thought: "💭 thought",
chore: "🧹 chore",
typo: "⌨️ typo",
polish: "💅 polish",
note: "🎵 note"
};
const NON_BLOCKING = [LABEL.nitpick, LABEL.thought, LABEL.note];
const COMMENT = {
[LABEL.praise]:
"Praise highlights 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.",
[LABEL.nitpick]:
"Nitpicks are trivial preference-based requests. These should be non-blocking by nature.",
[LABEL.suggestion]:
"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.",
[LABEL.issue]:
"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.",
[LABEL.todo]:
"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.",
[LABEL.question]:
"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.",
[LABEL.thought]:
"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.",
[LABEL.chore]:
"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.",
[LABEL.typo]:
"Typo comments are like todo:, where the main issue is a mispelling.",
[LABEL.polish]:
"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.",
[LABEL.note]:
"Notes are always non-blocking and simply highlight something the reader should take note of."
};
function post(key, token) {
const blockingText = NON_BLOCKING.includes(LABEL[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[LABEL[key]]} -->\n**${LABEL[key]}${blockingText}:** ‏`,
authenticity_token: token,
title: `${LABEL[key]}`,
}).toString(),
});
}
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!");
})(window.document);
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment