CONTRIBUTING.md

Como Contribuir

Quer contribuir para este repositório de alguma forma?
Veja abaixo as diferentes formas de como você pode fazer isso!

Antes de continuar... Para contribuir com este projeto, você precisará: Conta no GitHub Conhecimento básico de Git (fork, clone, commit, push) Para contribuições de código: ambiente PHP/Laravel configurado Para contribuições de tradução: fluência no idioma de destino Padronização de mensagens de commit seguindo Conventional Commits: feat, fix, add, trans, etc.

Encontrou um bug?

Antes de continuar, certifique-se de que o bug que você encontrou ainda não foi relatado na sessão Issues deste repositório.

• Se um bug NÃO estiver mencionado nas Issues, abra uma nova. Certifique-se de incluir um título, uma descrição clara do comportamento esperado que não está ocorrendo.

Tip

Evite abrir issues pedindo para ser ativamente "atribuído" a uma parte específica do código. Apenas relate o bug.

Deseja que uma nova funcionalidade seja adicionada?

Para sugerir ou implementar uma nova funcionalidade:

1. Proponha a ideia

   • Abra uma nova Issue
   • Descreva o que a funcionalidade deve fazer
   • Se possível, inclua casos de uso ou exemplos de implementação

2. Implementação (opcional)

   • Após feedback positivo na issue, você mesmo pode implementar a funcionalidade
   • Siga o mesmo fluxo descrito na seção Deseja contribuir com código?

Deseja contribuir com a documentação?

Caso tenha achado erros de digitação/formatação ou deseja melhorar a documentação:

1. Fork e Clone

   • Faça um fork do repositório
   • Clone seu fork: git clone https://github.com/SEU-USUARIO/PontuaDev_Project.git

2. Faça as alterações necessárias

   • Crie uma branch: git checkout -b doc-SEU-NOME, por exemplo, doc-gabriela.
   • Concentre-se em melhorar a clareza, corrigir erros ou adicionar informações úteis

3. Envie suas alterações

   • Commit e push: git commit -m "Docs corrigido links externos" && git push origin doc-SEU-NOME
   • Abra um Pull Request da sua branch com a branch master do repositório original
   • Aguarde a revisão para aprovação das suas mudanças.

Deseja traduzir a documentação?

Para adicionar uma nova tradução ao projeto:

1. Fork e Clone

   • Faça um fork do repositório
   • Clone seu fork: git clone https://github.com/SEU-USUARIO/PontuaDev_Project.git

2. Crie os arquivos de tradução

   • Crie uma branch: git checkout -b traducao-SEU-NOME, por exemplo, traducao-thiago.
   • Adicione seus arquivos na pasta docs/translations/ seguindo estas diretrizes:
     • Use o padrão README.[código do idioma].md (ex: README.en.md)
     • Use o código de idioma de duas letras conforme ISO 639-1
     • Mantenha a mesma estrutura e formatação do README original

3. Envie sua tradução

   • Commit e push: git commit -m "Trans adicionada tradução para [IDIOMA]" && git push origin traducao-SEU-NOME
   • Abra um Pull Request da sua branch com a branch master do repositório original
   • Aguarde a revisão para aprovação das suas mudanças.

Deseja contribuir com código?

Seja corrigindo um bug ou criando uma nova feature, para contribuir com código para o projeto, siga o fluxo padrão de GitHub:

1. Fork e Clone

   • Faça um fork do repositório
   • Clone seu fork: git clone https://github.com/SEU-USUARIO/PontuaDev_Project.git

2. Prepare seu ambiente

   • Crie uma branch para sua alteração: git checkout -b ajustes-SEU-NOME, por exemplo ajustes-joao.
   • Configure o ambiente Laravel:

     composer install && npm install
     cp .env.example .env && php artisan key:generate

3. Desenvolva e teste

   • Implemente suas alterações seguindo os padrões do projeto
   • Certifique-se que os testes passam: php artisan test

4. Envie sua contribuição

   • Commit e push: git commit -m "Fix problema de responsividade X" && git push origin ajustes-SEU-NOME
   • Abra um Pull Request da sua branch com a branch master do repositório original
   • Aguarde a revisão para aprovação das suas mudanças.

Important

Mantenha sua branch atualizada com o repositório principal antes de criar o Pull Request:

git remote add upstream https://github.com/juletopi/PontuaDev_Project.git
git fetch upstream && git rebase upstream/master

Tem alguma pergunta que deseja fazer?

• Faça qualquer pergunta sobre o repositório abrindo uma nova
  discussão na sessão de Discussions deste repositório.

---

E isso é tudo! Sinta-se livre para contribuir ou discutir sobre este repositório. Obrigado pela sua atenção!