Pular para conteúdo

Guia de contribuição

Algumas instruções legais, caso você queira contribuir com esse projeto ❤

O básico

Clone o repositório:

git clone https://github.com/dunossauro/pytest-do-zero

Crie uma branch:

git branch -m fix/aula-01-gramatica

Embora essa branch use conventional branch, isso não é um requisito, somente um exemplo.

Inicie seu ambiente:

poetry install

Faça suas alterações: ...

Veja o material renderizado, caso sua alteração seja no texto:

poetry run task serve #(1)!
  1. Inicia o servidor do mkdocs

Execute os testes, caso sua alteração envolva código:

poetry run task test

Adicione um changelog:

towncrier create #(1)!
Issue number (`+` if none): + #(2)!
Fragment type (adicionado, correcoes, alterado, ...): #(3)!
  1. Esse é o comando. Após isso o o cli exibirá uma opção.
  2. Aqui você deve adicionar o número da issue, caso houver
  3. Aqui você deve escolher um dos tipos, o que mais se aproxima da contribuição que fizer. Após isso o editor se abrirá em modo de texto.

Para mais informações sobre isso, vá para changelogs

Faça um commit:

git add .
git commit -m "fix: corrige a gramática na aula 01"

Embora esse commit use conventional commits, isso não é um requisito, somente um exemplo.

Abra um pull request:

TODO adicionar prints de como fazer isso

Changelogs

A ferramenta usada para os changelogs é o towncrier.

Uso básico:

towncrier create #(1)!
Issue number (`+` if none): + #(2)!
Fragment type (adicionado, correcoes, alterado, ...): #(3)!
  1. Esse é o comando. Após isso o o cli exibirá uma opção.
  2. Aqui você deve adicionar o número da issue, caso houver
  3. Aqui você deve escolher um dos tipos, o que mais se aproxima da contribuição que fizer. Após isso o editor se abrirá em modo de texto.

As entradas vão automaticamente para o diretório changelogs.d, caso isso apareça no seu diff.

Algumas coisas são importantes para geração do changelog

  • É importante que sua mensagem de mudança não tenha mais de uma linha.
  • Após o texto da alteração, adicione o seu @ do git: 
    Correções gramaticais na aula 01, por [@dunossauro](https://github.com/dunossauro){:target="_blank"}