Bem-vindo à PetDex! Agradecemos pelo seu interesse em contribuir para este projeto open source. Suas contribuições são fundamentais para o sucesso e a melhoria contínua deste projeto. Antes de começar, por favor, leia e siga estas diretrizes para garantir um processo de contribuição harmonioso e eficaz.
-
Forquilhando o Repositório: Faça um fork deste repositório para sua própria conta GitHub clicando no botão "Fork".
-
Clonando o Repositório: Clone o fork do repositório para a sua máquina local:
git clone <https://github.com/devhatt/pet-dex-backend> cd pet-dex-backend
-
Pegue uma Issue:
Navegue pelas "Issues" e de preferência por uma Issue marcada como "Good First Issue". As "Issues" dessa forma são especialmente indicadas para novos colaboradores e são pontos de partida acessíveis no projeto. Mas, caso não haja nenhuma assim ou você se considere apto a pegar outra sem essa marcação, você possui total liberdade para pegá-la.
Depois de escolher uma task, clique nela para obter mais detalhes.
Lembre-se: Tarefas com fotos ao lado direito já foram selecionadas por outros colaboradores. Geralmente, você terá uma semana para concluir a tarefa, mas isso pode variar dependendo das políticas do projeto.
-
Crie uma Branch: Crie uma branch para trabalhar nas suas alterações.
-
Faça Alterações: Faça as alterações desejadas no código, documentação, ou outros recursos.
-
Testes: Certifique-se de que todas as mudanças são testadas e não introduzem erros.
-
Commits Significativos: Faça commits significativos e com mensagens claras. Utilizando comando abaixo e seguindo as instruções o commit ficara no padrão utilizado no projeto.
git commit
-
Atualize a Documentação: Se necessário, atualize a documentação relevante para refletir suas mudanças.
-
Envie as Alterações: Envie suas alterações para o seu fork:
git push origin nome-da-sua-branch
-
Criação de Pull Request (PR): Abra um Pull Request pelo o seu fork para o repositorio da PetDex, descrevendo suas alterações e fornecendo contexto sobre o que foi feito.
-
Revisão de Código: A equipe de mantenedores do projeto irá revisar o seu PR. Esteja disposto a fazer ajustes se necessário.
-
Merge e Fechamento: Após a revisão bem-sucedida, suas alterações serão mescladas à branch principal. Seu PR será fechado.
-
- Documentação: Sempre atualize a documentação para refletir mudanças significativas.
- Testes: Certifique-se de que suas alterações não quebram testes existentes. Se necessário, adicione novos testes.
- Tamanho das Pull Requests: PRs menores são mais fáceis de revisar e mesclar. Tente manter o escopo de suas contribuições relativamente pequeno.
- Mantenha a Cortesia: Seja cortês e respeitoso ao discutir e revisar o trabalho de outros contribuidores.
Agradecemos por ajudar a melhorar a PetDex! Sua dedicação à qualidade e inovação é fundamental para o sucesso contínuo deste projeto.
Se você tiver alguma dúvida ou precisar de ajuda em qualquer etapa do processo de contribuição, sinta-se à vontade para criar um problema (issue) ou entrar em contato com a equipe de mantenedores.Discord