Skip to content

Latest commit

 

History

History
131 lines (86 loc) · 6.42 KB

CONTRIBUTING.md

File metadata and controls

131 lines (86 loc) · 6.42 KB

📖 Contribua com o Diciotech

Quer contribuir conosco?! Gratidão 💙

Neste guia vamos explicar como funcionam os processos para que você possa contribuir com o Diciotech.

🤔 Como contribuir

Existem diversas formas de contribuir com o projeto:

Adicionando um novo termo técnico no Diciotech

Adicione mais conteúdo no Diciotech abrindo um pull request com o termo que deseja que esteja presente no site. Para adicionar um novo termo, você deve acessar o arquivo assets/data/cards_pt-br.json e inserir um novo item na lista, seguindo a seguinte estrutura:

{
   "title": "Termo técnico",
   "description": "Explicação sobre o termo",
   "tags": ["Tag1"]
}

ou

{
   "title": "Termo técnico",
   "description": "Explicação sobre o termo",
   "content": {
        "code": "Código de exemplo"
   },
   "tags": ["Tag1", "Tag2"]
}

Observação: caso a sua contribuição não se alinhe com qualquer uma das tags disponíveis, listadas na seção seguinte, verifique a seção Adicionando uma nova tag no Diciotech.

Antes de abrir o pull request, algumas boas práticas devem ser seguidas para uma maior organização e estabilidade do Diciotech.

  • Se o termo conter um código de exemplo, evite o escrever em uma linguagem de programação específica, faça isso apenas se realmente necessário;

  • Um termo, deve ser vinculado a, no mínimo, uma tag;

  • Atribuir a um termo apenas as tags presentes nessa documentação, da exata mesma forma e escrita;

  • Evite duplicações de tags em um mesmo termo. Exemplo: "tags": ["Conceito", "Conceito"];

  • Tome a cuidado para que as tags atribuídas a um termo façam sentido com o mesmo.

Adicionando uma nova tag no Diciotech

Você pode contribuir com o projeto propondo uma nova tag e a apresentando, como sugestão, por meio de uma issue para que se possa abrir uma discussão a respeito, para uma futura adição através de pull request. As tags disponíveis sempre vão estar presentes nessa documentação.

Tags disponíveis:

  • Back-end;
  • Biblioteca;
  • Conceito;
  • Design;
  • Ferramenta;
  • Framework;
  • Front-end;
  • Mobile;
  • Paradigma;
  • Versionamento.

Antes de criar uma issue e abrir um PR, todas as tags devem seguir algumas boas práticas:

  • Todas as tags devem estar no singular;
  • Atualmente, as tags são case sensitivity, então, por padrão, apenas a primeira letra da tag deve ser maiúscula. Exemplo: Back-end, Conceito, Paradigma;
  • Para adicionar uma nova tag, primeiro deve criar uma issue e, caso as pessoas usuárias concordem, um pull request deve ser aberto, contendo a tag. A PR sendo aprovada, a nova tag poderá ser vinculada a um termo;
  • As tags devem ser mais generalistas e categóricas, já que dispomos de um campo de pesquisa para uma busca mais específica e precisa. Exemplo de tags: Front-end, Design, Back-end.

Reportando bugs

Se encontraste um bug você pode reportá-lo usando a ferramenta de issues do GitHub. Porém, antes de criar a issue com as informações sobre o bug, é importante fazer as seguintes verificações:

  1. Atualize seu repositório local na branch main mais recente. Talvez seu bug já tenha sido corrigido na versão mais recente;
  2. Verifique se o bug já foi reportado por outra pessoa, então faça uma busca pelas issues abertas.

Se o bug realmente não foi resolvido ou reportado, você pode criar uma nova issue. No título da issue tente resumir da melhor forma o problema encontrado.

Se possível inclua imagens ou vídeos à descrição do bug para facilitar o processo de reprodução. Você também deve adicionar o label bug à issue.

Indicando melhorias e pedindo funcionalidades

Outra ótima forma de contribuir é indicando melhorias ao código do projeto e em como ele está estruturado ou pedindo funcionalidades novas. Se você tem qualquer ideia de como podemos melhorar alguma abordagem na solução de problemas, refatoração de código, melhoria em algum recurso ou qualquer outra coisa relacionada, siga estes passos:

  1. Certifique-se de que sua ideia já não esteja sendo abordada em nosso roadmap;
  2. Verifique se a ideia já não está presente em nossas issues do GitHub.

Concluindo esses dois passos, você pode criar uma nova issue descrevendo as melhorias e usando o label feature.

Discutindo as issues

Antes de partirmos para o código em si é muito importante discutirmos com a comunidade como cada issue será abordada.

Issues que estão em processo de discussão devem receber o label discussion, indicando que aquela issue precisa de feedbacks da comunidade.

Fazendo pull requests

Antes de abrir o seu PR, faça um fork do projeto e trabalhe em cima de um branch diferente da main, implementando suas soluções. Para saber mais sobre pull requests e como eles funcionam, veja este link.

Antes de abrir seu PR (pull request):

  • Leia com atenção o README do projeto;
  • Se atente para que tenha um issue aberta relacionada ao seu PR;
  • Caso não tenha, crie uma seguindo o guia de contribuição.

Outras formas de contribuir

Se você não trabalha com código mas quer ajudar o projeto, existe muitas outras formas de contribuir:

  • Ajude com a documentação do projeto;
  • Fale sobre o projeto nas suas redes sociais;
  • Viu alguma discussão que te interessa e onde você pode acrescentar mesmo sem conhecimento técnico? Não se acanhe e participe também nas issues do GitHub.

Pensou em alguma outra forma de contribuir? Compartilha com a gente!