From b12623f584fcd5b748ab4f39a23318a3b97af75d Mon Sep 17 00:00:00 2001 From: Henrique Branco Date: Thu, 3 Oct 2024 08:51:45 -0300 Subject: [PATCH] =?UTF-8?q?feat:=20adi=C3=A7=C3=A3o=20do=20guia=20de=20con?= =?UTF-8?q?tribui=C3=A7=C3=A3o?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CONTRIBUTING.md | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..668575e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,41 @@ +# Guia de contribuição + +## Regras de Contribuição + +Para mantermos o projeto organizado, siga estas orientações ao contribuir: +- As pastas devem começar com números sequenciais, seguidos de um hífen e o nome da pasta. + - Exemplo: `01-instalacao-python` + - Cada pasta representa uma seção no menu lateral esquerdo do livro. + - Não utilize acentos, espaços em branco ou caracteres especiais no nome das pastas. +- Os arquivos dentro das pastas também seguem essa numeração e formato de nome. + - Exemplo: `01-intro.md` + - Não utilize acentos, espaços em branco ou caracteres especiais no nome dos arquivos. + - Cada arquivo será uma subseção no menu lateral esquerdo. +- O arquivo `_toc.yml` configura o menu lateral do livro. **Não esqueça de atualizá-lo** sempre que adicionar um novo arquivo ou pasta. +- Você pode escrever o conteúdo do livro tanto em formato `.md` quanto em formato `.ipynb`. +- As imagens e gifs devem seguir o padrão de nomeação: + - `--descricao-da-imagem-ou-gif.extensao`. Exemplo: `09-03-modulos.png` + - Esses arquivos são armazenados nas pastas `book/img` e `book/gifs`. Siga o padrão já existente para manter a consistência. + +## Como contribuir + +1. Faça um **fork** deste repositório para sua conta do GitHub. +2. Clone o seu repositório para a sua máquina. +3. Instale o poetry com o comando: +```bash +pip install poetry +``` +4. Instale as dependências do projeto com o comando: +```bash +poetry install --with dev +``` +5. Faça suas alterações. Caso adicione novos arquivos ou pastas, **lembre-se de adicioná-los em `book/_toc.yml`**. +6. Teste o build local do livro com o comando abaixo. O buid deve ser executado sem erros. +```bash +task build +``` +7. Faça o commit e o push das suas alterações para o seu repositório. +8. Abra um Pull Request para o repositório original, explicando as mudanças que você fez. +9. Vincule alguma issue se houver para que ela seja encerrada automaticamente quando o PR for aceito. Caso tenha dúvidas de como fazer esta etapa, consulte este [link](https://docs.github.com/pt/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue). +10. Suas alterações passarão por uma revisão antes de serem aceitas. +11. Após aprovadas, suas alterações serão refletidas no livro em poucos minutos!