Skip to content

Latest commit

 

History

History
82 lines (62 loc) · 3.77 KB

CONTRIBUTING.md

File metadata and controls

82 lines (62 loc) · 3.77 KB

Guia do contribuidor

Qualquer pessoa é bem-vinda à contribuir!

Primeiro, eu, Henrique Junqueira Branco, gostaria de lhe dar os parabéns pela contribuição voluntária neste projeto que pode tocar a vida de milhares de pessoas que tem o desejo de aprender cada vez mais! Meus sinceros parabéns! 👏 🙌 👏

Código de conduta

Toda contribuição, por menor que seja, está sujeita ao Código de Conduta do projeto.

Licença

Toda contribuição, por menor que seja, está sujeita aos termos da licença Creative Commons Legal Code.

Como não contribuir?

  • Violar o Código de Conduta mencioando acima
  • Violar os termos da licença mencionada acima
  • Não seguir os padrões aqui estabelecidos (pull requests não serão aprovados!)

Como contribuir?

Há várias formas para contribuir independente do seu nível:

  • Corrigir erros gramaticais em português.
  • Sugerir traduções mais precisas.
  • Revisar o código.
  • Traduzir algum trecho, capítulo ou seção não iniciados ou finalizados ainda.
  • Corrigir ou apontar links inexistentes e outros bugs.

Fluxo de contribuição

Toda contribuição é feita através de issues e pull requests (PRs), conforme as seguintes regras:

Cada commit deve:

  • ser pequenos.
  • ter um único tema (tradução, correção gramatical, sugestão, etc.).
  • seguir o padrão do commitzen podendo ser adaptado para o projeto.

Exemplo de alguns tipos de commits:

trans:          tradução de um capítulo, seção ou trecho
fix(script.py): correção de bug
gram-pt:        correção gramatical de português
gram-en:        correção gramatical de inglês 
feat:           sugestões de melhorias no projeto/tradução
style:          sugestão de alguma troca de estilo ao longo do projeto
...

Não há nada escrito em pedras, desde que siga o padrão! ✌️

Cada issue deve:

  • ser clara e específica à qual parte do projeto/tradução ele se refere.
  • ter um label adequado (tradução, remoção de trecho, correção gramatical, bug, documentação, etc.).
  • ter preferencialmente algum responsável.
  • ser fechado quando concluído (manualmente ou através de PRs).

Cada PR deve:

  • ter seu nome e escopo bem definido.
  • resolver um problema ou sugerir uma melhoria de forma saudável.
  • encerrar o issue linkado à ele, caso exista.
  • em caso de reporte de bug, ser específico e fornecer um guia explicativo para reprodução do bug.
  • seguir os padrões pré-definidos no projeto (nome de pastas, ícones, imagens, ordem dos capítulos, gifs, etc.)

Códigos funcionais

O trabalho não consiste apenas na tradução simples e pura. Deve-se testar todos os códigos antes de serem feitos quaisquer commits. A ideia é garantir que outras pessoas possam reutilizar o projeto. Desta forma, todos os códigos devem ser testados de forma simples antes de serem simplesmente alocados em uma seção da tradução.

Começou e não conseguiu/não quer finalizar?

Se caso você começou uma tradução de um capítulo/trecho e não quer ou não pode mais continuar, por qualquer que seja o motivo, sem crise! É só comunicar. Seu nome ainda sim vai para a lista de contribuidores.

Minha sugestão foi aceita, o que eu ganho?

Caso seu PR seja aprovado, você irá automaticamente para a lista de contribuintes do projeto no README.md da página inicial, como forma de agradecimento pela colaboração.

Mas lembre-se, a recompensa é somente se seguir os padrões pré-estabelecidos acima, para mantermos a organização de um projeto que pode impactar muitas pessoas!