From 749aed1d3a6b9ddecb3d62c97244cb05efb2470d Mon Sep 17 00:00:00 2001 From: Marcos Fonseca Date: Sat, 12 Oct 2024 20:55:50 -0300 Subject: [PATCH 1/2] docs: add CONTRIBUTING.md guidelines --- CONTRIBUTING.md | 77 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 77 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..8712194 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,77 @@ +# Contribuindo para o projeto + +Agradecemos o seu interesse em contribuir para a nossa plataforma! Este documento contém as diretrizes para contribuir com o projeto. Siga-as para garantir a consistência e qualidade das contribuições. + +## Pré-requisitos para Contribuir + +Antes de começar a contribuir, certifique-se de ter: + + - Docker instalado em seu ambiente. + - Uma conta no Google Console para criar credenciais de API necessárias para acessar o Google Calendar e Gmail. + +## Como Contribuir + +1. **Fork e Clone:** + + Faça um fork do repositório no GitHub. + Clone o seu fork para o seu ambiente de desenvolvimento local. + ```bash + git clone git@github.com:dedevpradev/faladev.git && cd faladev + ``` + +2. **Configurar Ambiente:** + + Configure as variáveis de ambiente conforme necessário para acessar serviços do Google. + Execute o Docker Compose para subir a aplicação: + ```bash + docker-compose up -d + ``` + +3. **Trabalhando com Branches:** + + Crie uma branch a partir da `main` para cada nova funcionalidade ou correção. + ```bash + git checkout -b feature/nome-da-branch + ``` + +4. **Desenvolvimento:** + + Siga as boas práticas de desenvolvimento conforme discutido no projeto. + Adicione ou atualize os testes conforme necessário. + Verifique se o código segue os padrões estabelecidos e não introduz problemas novos. + +5. **Documentação:** + + Atualize a documentação conforme necessário. + Se você adicionou novas funcionalidades, atualize a documentação Swagger conforme as instruções no `README.md`. + +6. **Commit e Push:** + + Use mensagens de commit claras e descritivas. + Envie suas alterações para o seu fork. + ```bash + git commit -m "Descrição clara e concisa do que foi feito" + ``` + + ```bash + git push origin nome-da-branch + ``` + +7. **Pull Request:** + + Faça um pull request da sua branch no seu fork para a branch `main` do repositório original. + Descreva claramente o que o seu código faz e por que a sua contribuição é importante. + Link qualquer issue relevante no seu pull request. + +8. **Revisão:** + + Aguarde feedback ou aprovação dos mantenedores do projeto. + Faça as alterações necessárias se solicitado pelos revisores. + +## Código de Conduta + +Ao participar deste projeto, espera-se que você trate todos os contribuidores com respeito e contribua ativamente para a criação de um ambiente acolhedor para todos, independentemente de sua senioridade. + +## Dúvidas? + +Se tiver dúvidas ou precisar de ajuda, não hesite em abrir uma issue no GitHub para solicitar mais informações ou suporte. \ No newline at end of file From b473a8f053ad767894086d13ea82f9973ca6296d Mon Sep 17 00:00:00 2001 From: Marcos Fonseca Date: Sat, 12 Oct 2024 20:55:56 -0300 Subject: [PATCH 2/2] docs: add CONTRIBUTING.md guidelines --- CONTRIBUTING.md | 61 ++++++++++++++++++++++++++++++++++--------------- 1 file changed, 42 insertions(+), 19 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8712194..e339fde 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -15,39 +15,62 @@ Antes de começar a contribuir, certifique-se de ter: Faça um fork do repositório no GitHub. Clone o seu fork para o seu ambiente de desenvolvimento local. + ```bash - git clone git@github.com:dedevpradev/faladev.git && cd faladev + git clone && cd faladev ``` 2. **Configurar Ambiente:** Configure as variáveis de ambiente conforme necessário para acessar serviços do Google. + Execute o Docker Compose para subir a aplicação: + ```bash docker-compose up -d ``` -3. **Trabalhando com Branches:** +## 3. Trabalhando com Branches - Crie uma branch a partir da `main` para cada nova funcionalidade ou correção. - ```bash - git checkout -b feature/nome-da-branch - ``` + Crie uma branch a partir da `main` para cada nova funcionalidade, correção ou alteração na documentação. Siga um padrão claro para nomear as branches, facilitando o entendimento e a organização do trabalho: + + - **feature/**: Para novas funcionalidades. + + - Exemplo: `feature/add-user-login` + + - **bugfix/**: Para correções de bugs. + + - Exemplo: `bugfix/fix-login-error` + - **docs/**: Para mudanças na documentação. + + - Exemplo: `docs/add-contributing-md` + + - **chore/**: Para tarefas administrativas ou de manutenção. + + - Exemplo: `chore/update-dependencies` + + Crie a branch usando o comando abaixo: + + ```bash + git checkout -b feature/nome-da-branch + ``` + 4. **Desenvolvimento:** - Siga as boas práticas de desenvolvimento conforme discutido no projeto. - Adicione ou atualize os testes conforme necessário. - Verifique se o código segue os padrões estabelecidos e não introduz problemas novos. + - Siga as boas práticas de desenvolvimento conforme discutido no projeto. + - Adicione ou atualize os testes conforme necessário. + - Verifique se o código segue os padrões estabelecidos e não introduz problemas novos. 5. **Documentação:** - Atualize a documentação conforme necessário. - Se você adicionou novas funcionalidades, atualize a documentação Swagger conforme as instruções no `README.md`. + - Atualize a documentação conforme necessário. + - Se você adicionou novas funcionalidades, atualize a documentação Swagger conforme as instruções no `README.md`. 6. **Commit e Push:** - Use mensagens de commit claras e descritivas. + Use mensagens de commit claras e descritivas. Um exemplo recomendado é seguir o padrão **Conventional Commits**, adicionando prefixos como `feat:`, `fix:`, `docs:`, e `chore:` na mensagem de commit. + Envie suas alterações para o seu fork. ```bash git commit -m "Descrição clara e concisa do que foi feito" @@ -59,19 +82,19 @@ Antes de começar a contribuir, certifique-se de ter: 7. **Pull Request:** - Faça um pull request da sua branch no seu fork para a branch `main` do repositório original. - Descreva claramente o que o seu código faz e por que a sua contribuição é importante. - Link qualquer issue relevante no seu pull request. + - Faça um pull request da sua branch no seu fork para a branch `main` do repositório original. + - Descreva claramente o que o seu código faz e por que a sua contribuição é importante. + - Link qualquer issue relevante no seu pull request. 8. **Revisão:** - Aguarde feedback ou aprovação dos mantenedores do projeto. - Faça as alterações necessárias se solicitado pelos revisores. + - Aguarde feedback ou aprovação dos mantenedores do projeto. + - Faça as alterações necessárias se solicitado pelos revisores. ## Código de Conduta -Ao participar deste projeto, espera-se que você trate todos os contribuidores com respeito e contribua ativamente para a criação de um ambiente acolhedor para todos, independentemente de sua senioridade. + Ao participar deste projeto, espera-se que você trate todos os contribuidores com respeito e contribua ativamente para a criação de um ambiente acolhedor para todos, independentemente de sua senioridade. ## Dúvidas? -Se tiver dúvidas ou precisar de ajuda, não hesite em abrir uma issue no GitHub para solicitar mais informações ou suporte. \ No newline at end of file + Se tiver dúvidas ou precisar de ajuda, não hesite em abrir uma issue no GitHub para solicitar mais informações ou suporte. \ No newline at end of file