CONTRIBUTING.md

Como contribuir

Primeiramente, muito obrigado pela disponibilidade em querer contribuir! 🫶

Estava lendo o repositório e teve uma nova ideia? Não entendeu alguma explicação, encontrou erros de grafia ou de código? Aqui você encontra um guia para você colaborar com a melhoria do material, indepedente do seu nível de conhecimento.

Entenda que não existem dúvidas simples demais e que toda contribuição é recebida com igual entusiasmo.

Código de conduta

Trate todos igualmente com respeito e siga o nosso código de conduta.

Contribuições possíveis

Você pode ajudar o projeto das seguintes maneiras:

• Lendo o conteúdo e divulgando a seus conhecidos;
• Reportando erros de grafia encontrados no texto;
• Questionando explicações e solicitando uma melhoria no texto;
• Sugerindo melhorias do conteúdo;
• Adicionando novos materiais e tópicos.

Sua primeira contribuição?

Caso queira apenas sugerir alguma modificação no conteúdo, vá em issues, certifique-se que alguém já não tenha feito a sugestão que você pretendia e tente descrver com maior riqueza de detalhes possíveis. Quando necessário adicione imagens (principalmente quando for um erro).

Uma outra maneira de contribuir, é editando você mesmo os arquivos através do github.

Acesse a pasta docs/ e escolha o arquivo que irá editar.

Após escolher o arquivo, clique no lápis que aparece do lado direito para iniciar a edição do arquivo.

Faça as alterações necessárias e e depois siga até o fim da página.

Por fim, inicie a proposta de mudança.

Confira as alterações realizadas e através do botão Create pull request.

Seu pedido de melhoria deve estar prenchido com o que preencheu anteriormente, mas caso precise, complemente com maiores detalhes. Clique no botão Create pull request para finalizar a contribuição e aguarde.

Assim que a pessoa responsável analisar sua contribuição, suas alteraçês serão mescladas ao conteúdo.

🤖 Automaticamente, em poucos minutos uma nova versão do site já estará disponível!

Desenvolvendo localmente

Crie um comando virtual utiliando o comando:

python -m venv .venv

Ative o ambiente através do comando:

source .venv/bin/activate

ou equivalente em seu sistema operacional.

Em seguida instale as dependências necesárias

python -m pip install -r requirements.txt

e para executar localmente:

python -m mkdocs serve

Convenções utilizadas e dicas

• Não utilize emojis de forma textual :emoji:, copie do emojipédia o invés;
• Todo título de seção é iniciado com um emoji;
• Novos capítulos devem ser adicionados também no menu de navegação que se encontra no arquivo mkdocs.yml;