Como Contribuir

Agradecemos o seu interesse em contribuir para o Projeto Base USP! Para garantir a qualidade e a consistência do projeto, pedimos que siga estas diretrizes:

Reportando Bugs e Sugestões

• Verifique Issues Existentes: Antes de criar uma nova issue, por favor, verifique se já não existe uma issue aberta (ou fechada recentemente) relatando o mesmo problema ou sugestão.
• Crie uma Issue: Se não encontrar nada relacionado, abra uma nova issue no repositório do projeto no GitHub.
  • Para Bugs: Descreva o problema detalhadamente, incluindo passos para reproduzi-lo, o comportamento esperado, o comportamento observado, mensagens de erro (se houver), versão do PHP, Laravel e do projeto base, e qualquer outra informação relevante do seu ambiente.
  • Para Sugestões: Descreva claramente a funcionalidade ou melhoria desejada, explicando o porquê ela seria útil para o projeto base.

Desenvolvendo e Submetendo Alterações (Pull Requests)

1. Fork o Repositório: Crie um fork do repositório principal para a sua conta no GitHub.
2. Crie uma Branch: Crie uma branch descritiva para a sua feature ou correção a partir da branch principal (geralmente main ou master). Ex: feature/nova-funcionalidade ou fix/bug-no-login.

   git checkout -b feature/minha-nova-feature
   

3. Desenvolva: Implemente sua feature ou correção.
   • Siga os Padrões: Certifique-se de que seu código segue os Padrões de Código e Boas Práticas definidos (PSR-12, convenções Laravel, etc.). Use o Laravel Pint para ajudar na formatação (./vendor/bin/pint).
   • Escreva Testes: Adicione testes automatizados (Unit, Feature ou Browser) que cubram suas alterações. Garanta que todos os testes existentes continuam passando (php artisan test, php artisan dusk).
   • Mantenha o Histórico Limpo: Faça commits atômicos e com mensagens claras seguindo o padrão Conventional Commits (recomendado).
4. Atualize sua Branch: Antes de submeter, atualize sua branch com as últimas alterações da branch principal do repositório original.

   git fetch upstream
   git rebase upstream/main # ou o nome da branch principal
   # Resolva conflitos, se houver
   

5. Push para seu Fork: Envie sua branch para o seu fork no GitHub.

   git push origin feature/minha-nova-feature
   

6. Abra um Pull Request (PR): No GitHub, vá para o repositório original e abra um Pull Request comparando a sua branch com a branch principal do repositório original.
   • Descrição Clara: Descreva suas alterações no PR, o problema que ele resolve ou a feature que adiciona, e faça referência à issue correspondente (#issue-number).
   • Revisão: Sua contribuição será revisada pela equipe mantenedora. Esteja aberto(a) a feedbacks e discussões.

Agradecemos sua colaboração!