Skip to content

Latest commit

 

History

History
106 lines (77 loc) · 4.17 KB

CONTRIBUTING.md

File metadata and controls

106 lines (77 loc) · 4.17 KB
Raw

📖 Contribua com o Diciotech

Que bom que você resolveu contribuir conosco, obrigado 💙! Neste guia vamos explicar como funcionam os processos para que você possa contribuir com esse projeto.

🤔 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 mostrar 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. Por exemplo:

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

ou

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

Reportando bugs

Se encontrou um bug você pode reportá-lo usando a ferramenta de issues do GitHub. Porém antes de enviar seu 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 fazendo uma busca pelas issues.

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. Também verifique se a ideia já não está pressente 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 dos inputs e feedbacks da comunidade.

Fazendo pull requests

Para isso faça um fork do projeto e trabalhe em cima de um branch diferente de 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!