Skip to content

Instantly share code, notes, and snippets.

@kikocastro
kikocastro / github-conventional-comments.js
Created May 20, 2021 15:03 — forked from ifyoumakeit/github-conventional-comments.js
GitHub Conventional Comments (instructions to install in comment below code)
{
// https://conventionalcomments.org/#labels
const LABELS = [
["praise", "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", "Nitpicks are small, trivial, but necessary changes. Distinguishing nitpick comments significantly helps direct the reader's attention to comments requiring more involvement."],
["suggestion", "Suggestions are specific requests to improve the subject under review. It is assumed that we all want to do what's best, so these comments are never dismissed as “mere suggestions”, but are taken seriously."],
["issue", "Issues represent user-facing problems. If possible, it's great to follow this kind of comment with a suggestion."],
["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