|
| 1 | +# Guia de Contribuição |
| 2 | + |
| 3 | +Agradecemos pelo tempo que dedicou a vir até o projeto e chegar nessa página. Criamos algumas "regras" para contribuição para que o projeto mantenha-se o mais organizado possível e também para facilitar não só para quem contribui, mas para a equipe que acaba tendo que revisar as alteraçõs/adições sugeridas por todos vocês. |
| 4 | + |
| 5 | +## Como contribuir |
| 6 | + |
| 7 | +### Membros da equipe do projeto |
| 8 | +1. **Não** faça commits direto na `main`. |
| 9 | +2. Crie uma branch diretamente no repositório da organização: |
| 10 | + `git checkout -b feature/nome-da-pagina` |
| 11 | +3. Após terminar, abra um **Pull Request** |
| 12 | +4. Não precisa deletar a branch do repositório remoto, ela será deletada automaticamente após o merge. |
| 13 | +5. Sincronize o repositório local |
| 14 | +```bash |
| 15 | +git checkout main # volta para a branch main |
| 16 | +git pull origin main # sincroniza o repositório local com o que acabou de ser atualizado no repositório remoto |
| 17 | +git branch -D feature/nome-da-pagina # deleta a branch do repositório local |
| 18 | +``` |
| 19 | + |
| 20 | +### Contribuidor externo |
| 21 | +1. Faça um **fork** do projeto para a sua conta pessoal. |
| 22 | +2. Cria uma branch em seu fork no formato "feature/pagina-ou-assunto": |
| 23 | +```bash |
| 24 | +git checkout -b feature/nome-da-pagina ## se alterar mais de um arquivo, se possivel crie branches separadas |
| 25 | +``` |
| 26 | +3. Faça o push para seu repositório normalmente |
| 27 | + `git push origin features/nome-da-pagina` |
| 28 | +4. Envie um **Pull Request** para a nossa branch `main`. |
| 29 | +5. Sincronize o repositório local |
| 30 | +```bash |
| 31 | +git checkout main # volta para a branch main |
| 32 | +git pull origin main # sincroniza o repositório local com o que acabou de ser atualizado no repositório remoto |
| 33 | +git branch -D feature/nome-da-pagina # deleta a branch do repositório local |
| 34 | +``` |
| 35 | + |
| 36 | +## Regras de ouro |
| 37 | +* **Commits atômicos**: Tente fazer commits que mexam em uma coisa por vez. |
| 38 | +* **Mensagens dos commits**: Sejam claros e objetivos. Use algo como: `Criação da página...`, `Adição ...`, `Edição/Correção...` |
| 39 | +* **Pull Requests**: Todos os PRs passam por revisão da equipe do projeto |
| 40 | + * Usamos **Squash and Merge** para manter o histórico da branch `main` linear e limpo. |
| 41 | + * Por favor, use o campo de descrição da PR para detalhar o que foi alterado. |
| 42 | + |
| 43 | +## Código de Conduta |
| 44 | +Ao participar deste projeto, você concorda em manter um ambiente respeitoso e colaborativo. |
0 commit comments