Skip to content

Instantly share code, notes, and snippets.

Show Gist options
  • Save tomsihap/f022661ab9957eabba4e65e863ac6092 to your computer and use it in GitHub Desktop.
Save tomsihap/f022661ab9957eabba4e65e863ac6092 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 DATA = {
praise: { label: "👏 praise", 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."},
nitpick: { label: "🤓 nitpick", comment: "Nitpicks are small, trivial, but necessary changes. Distinguishing nitpick comments significantly helps direct the reader's attention to comments requiring more involvement." },
suggestion: { label: "💡 suggestion", comment: "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." },
issue: { label: "Ø issue", comment: "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." },
question: { label: "❓ question", comment: "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." },
thought: { label: "💭 thought", comment: "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." },
chore: { label: "🧹 chore", comment: "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." },
};
function post(key, token) {
return fetch("replies", {
headers: { "content-type": "application/x-www-form-urlencoded" },
method: "POST",
mode: "cors",
credentials: "include",
body: new URLSearchParams({
body: `<!-- ${DATA[key].comment} -->\n**${DATA[key].label}:**‏`,
authenticity_token: token,
title: `${key[0].toUpperCase()}${key.slice(1)}`,
}).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(DATA).map(key => post(key, token)));
console.log("All added! Refresh the page!");
})(window.document);
@tomsihap
Copy link
Author

tomsihap commented Feb 3, 2023

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 https://github.com/settings/replies
  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.

@see: https://gist.github.com/ifyoumakeit/4148a8c3e61b7868935651272c03f793?permalink_comment_id=3407412#gistcomment-3407412

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