Conventional comments

Install comment

// Menu: Conventional comment
// Description: Comments that are easy to grok and grep
// Author: Jakub Olek
// Twitter: @JakubOlek
// Shortcut: opt 0
// Based on: https://hemdan.hashnode.dev/conventional-comments

const type = await arg("Label", [
  {
    name: "👏 praise",
    value: "**👏 praise**: ",
    description:
      "Praises highlight something positive. Try to leave at least one of these comments per review (if it exists :^)",
  },
  {
    name: "🤓 nitpick",
    value: "**🤓 nitpick**: ",
    description:
      "Nitpicks are small, trivial, but necessary changes. Distinguishing nitpick comments significantly helps direct the reader's attention to comments requiring more involvement.",
  },
  {
    name: "🎯 suggestion",
    value: "**🎯 suggestion**: ",
    description:
      "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.",
  },
  {
    name: "🔨 issue",
    value: "**🔨 issue**: ",
    description:
      "Issues represent user-facing problems. If possible, it's great to follow this kind of comment with a suggestion.",
  },
  {
    name: "❔ question",
    value: "**❔ question**: ",
    description:
      "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.",
  },
  {
    name: "💭 thought",
    value: "**💭 thought**: ",
    description:
      "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.",
  },
  {
    name: "💣 chore",
    value: "**💣 chore**: ",
    description:
      "Chores are simple tasks that must be done before the subject can be “officially” accepted. Usually, these comments reference some common processes. Try to leave a link to the process described so that the reader knows how to resolve the chore.",
  },
]);

setSelectedText(type);

Simple list of conventional comments ready to be used. https://conventionalcomments.org/