Skip to content

Instantly share code, notes, and snippets.

@gnomex
Forked from pauloportella/conventional-comments.md
Last active December 28, 2023 19:40
Show Gist options
  • Save gnomex/b0592048288069cf5c3445f2b51d9110 to your computer and use it in GitHub Desktop.
Save gnomex/b0592048288069cf5c3445f2b51d9110 to your computer and use it in GitHub Desktop.
How to setup conventional comments on Github

Conventional comments

Fonte

Você pode adicionar todos os marcadores de convenções de comentários no Github como mensagens salvas seguindo os passos:

  1. Vá para https://github.com/settings/replies
  2. Abra o Developer Tools 2.1 digite allow paste para conseguir colar o script lá
  3. Copie o código abaixo e cole no console
  4. Presione enter, aguarde e recarregue a página
{
  const LABELS = [
    ["👏 praise", "Praises (elogios) destacam algo positivo. Tente deixar pelo menos um desses comentários por revisão. Não deixe elogios falsos (que na verdade podem ser prejudiciais). Procure algo para elogiar sinceramente."],
    ["🤓 nitpick", "Nitpicks (detalhes) são solicitações simples baseadas em preferências. Estes comentários são não bloqueantes (non-blocking) por natureza."],
    ["🎯 suggestion", "Suggestions (sugestões) propõem melhorias para o assunto indicado. É importante ser explícito e claro sobre o que está sendo sugerido e por que é uma melhoria. Considere o uso de patches (trechos de códigos) e das decorações (blocking) ou (non-blocking) para deixar seu comentário ainda mais claro."],
    ["🔨 issue", "Issues (questões) destacam problemas específicos com o assunto em análise. Esses problemas podem estar expostos para o usuário ou estar nos bastidores. É altamente recomendável associar este comentário com uma suggestion:. Se você não tiver certeza se existe um problema ou não, considere deixar uma question:"],
    ["❔ question", "Questions (perguntas) são apropriadas se você tem uma preocupação em potencial, mas não tem certeza se é relevante ou não. Pedir um esclarecimento ou investigação ao autor pode levar a uma resolução mais rápida."],
    ["💭 thought", "Thoughts (pensamentos) representam uma ideia que surgiu da revisão. Esses comentários são não bloqueantes (non-blocking) por natureza, mas são extremamente valiosos e podem levar a iniciativas mais focadas e oportunidades de orientação."],
    ["💣 chore", "Chores (afazeres) são tarefas simples que devem ser feitas antes que o assunto possa ser aceito “oficialmente”. Normalmente, esses comentários fazem referência a algum processo comum. Tente deixar um link para a descrição do processo para que o leitor saiba como resolver a tarefa."],
    ["🔲 todo", "To-do's (tarefas) são mudanças pequenas, simples, mas necessárias. Distinguir comentários de todo: dos de issue: e suggestion: ajuda a direcionar a atenção do leitor para comentários que exigem mais envolvimento."],
    ["a̶b typo", "Typos (erros de digitação) são como todo:, em que o principal problema é uma escrita incorreta."],
    ["🎈 polish", "Polish (polimento) são como uma suggestion:, em que não há nada necessariamente errado com o conteúdo apontado, há apenas algumas maneiras de melhorar imediatamente a qualidade."],
  ];
  const form = document.querySelector(".new_saved_reply");
  const authenticity_token = encodeURIComponent(
    form.querySelector("[name=authenticity_token]").value
  );
  Promise.all(
    LABELS.map(([type, note], index) => {
      const title = encodeURIComponent(`${type[0].toUpperCase()}${type.slice(1)}`);
      const body = encodeURIComponent(`<!-- ${note}  -->\n**${type}:** ‏`);
      return fetch("replies", {
        headers: {
          accept:
            "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.9",
          "accept-language": "en-US,en;q=0.9",
          "cache-control": "no-cache",
          "content-type": "application/x-www-form-urlencoded",
          pragma: "no-cache",
          "sec-fetch-dest": "document",
          "sec-fetch-mode": "navigate",
          "sec-fetch-site": "same-origin",
          "sec-fetch-user": "?1",
          "upgrade-insecure-requests": "1",
        },
        referrer: "https://github.com/settings/replies",
        referrerPolicy: "strict-origin-when-cross-origin",
        body: `authenticity_token=${authenticity_token}&title=${title}&saved_reply_id=&body=${body}&path=&line=&start_line=&preview_side=&preview_start_side=&start_commit_oid=&end_commit_oid=&base_commit_oid=&comment_id=`,
        method: "POST",
        mode: "cors",
        credentials: "include",
      })
    })
  ).then(() => console.log("Pronto! Recarregue a página!"));
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment