From d50e21ac48c24daec3a967fa100d3bde9ed51831 Mon Sep 17 00:00:00 2001 From: GabrielCastelo-31 Date: Wed, 3 Jan 2024 19:30:03 -0300 Subject: [PATCH 1/9] =?UTF-8?q?Adiciona=20template=20de=20pull=20request?= =?UTF-8?q?=20para=20contribui=C3=A7=C3=A3o.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../pull_request_template.md | 59 +++++++++++++++++++ 1 file changed, 59 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE/pull_request_template.md diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md new file mode 100644 index 0000000..1acfabd --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -0,0 +1,59 @@ +## Modelo de Solicitação de Pull Request +Por favor, siga estas etapas antes de enviar um PR. + +1. Certifique-se de que seu PR não seja duplicado. +2. Se não for, então certifique-se de que: + + a. Você fez suas alterações em um branch separado. Os branches DEVEM ter nomes descritivos que comecem com os prefixos `fix/` ou `task`. Bons exemplos são: `fix/signin-issue`,`task/issue-templates` ou `task/add-search-by-name`. + + b. Você sincronizou sua branch com a branch `main` do repositório, para que seu PR possa ser mesclado facilmente.(`git pull origin main`) + + c. Você tem mensagens de commit descritivas com um título curto (primeira linha). + + d. `make testfull` não gera nenhum erro e possui mais de 90% de _code coverage_. Se ocorrerem erros, corrija-os primeiro e emende seu commit (`git commit --amend`). + +3. **Após** essas etapas, você está pronto para abrir um pull request. + + a. Dê um título descritivo ao seu PR. + + b. Descreva suas alterações. + + c. Coloque `closes #XXXX` em seu comentário para fechar automaticamente a issue que seu PR corrige (se houver). + +IMPORTANTE: Por favor, revise a paǵina de [COMO CONTRIBUIR ?](https://unb-mds.github.io/2023-2-SuaGradeUnB/contributing/) para obter diretrizes detalhadas sobre contribuições. + +**POR FAVOR, REMOVA O MODELO ACIMA ANTES DE ENVIAR** + +# Descrição + +Por favor, inclua um resumo das alterações e a issue relacionada. Também inclua motivação e contexto relevantes. Liste quaisquer dependências necessárias para essa alteração. + +**closes # (issue)** (_caso exista_) + +## Tipo de alteração + +Por favor, exclua as opções que não são relevantes. + + +- [ ] Bug fix (alteração que corrige um problema) +- [ ] New feature (alteração que adiciona funcionalidade) +- [ ] Breaking change (correção ou funcionalidade que altera o comportamento de outras partes do sistema de maneira significativa) +- [ ] Documentation update (alteração na documentação) + +# Como isso foi testado? + +Por favor, descreva os testes que você executou para verificar suas alterações. Forneça instruções para que possamos reproduzir. Liste também quaisquer detalhes relevantes para a configuração de seus testes. + +- [ ] Teste A +- [ ] Teste B + +# Checklist: + +- [ ] Meu código segue as diretrizes de contribuição deste projeto +- [ ] Realizei uma revisão pessoal do meu código +- [ ] Comentei meu código, especialmente em áreas de difícil compreensão +- [ ] Fiz alterações correspondentes na documentação _( se necessário)_ +- [ ] Minhas alterações não geram novos _warnings_ ou erros +- [ ] Adicionei testes que comprovam que minha correção é eficaz ou que minha funcionalidade está funcionando corretamente +- [ ] Testes unitários novos e existentes passam localmente com minhas alterações + From b400c00c0c8d06aa54f93e535f4e1983278f6493 Mon Sep 17 00:00:00 2001 From: GabrielCastelo-31 Date: Sat, 6 Jan 2024 22:54:24 -0300 Subject: [PATCH 2/9] fix codacy markdown issues --- .../pull_request_template.md | 46 +++++++++---------- 1 file changed, 23 insertions(+), 23 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md index 1acfabd..dae2719 100644 --- a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -1,24 +1,26 @@ ## Modelo de Solicitação de Pull Request + Por favor, siga estas etapas antes de enviar um PR. 1. Certifique-se de que seu PR não seja duplicado. + 2. Se não for, então certifique-se de que: - a. Você fez suas alterações em um branch separado. Os branches DEVEM ter nomes descritivos que comecem com os prefixos `fix/` ou `task`. Bons exemplos são: `fix/signin-issue`,`task/issue-templates` ou `task/add-search-by-name`. + a. Você fez suas alterações em um branch separado. Os branches DEVEM ter nomes descritivos que comecem com os prefixos `fix/` ou `task`. Bons exemplos são: `fix/signin-issue`,`task/issue-templates` ou `task/add-search-by-name`. - b. Você sincronizou sua branch com a branch `main` do repositório, para que seu PR possa ser mesclado facilmente.(`git pull origin main`) + b. Você sincronizou sua branch com a branch `main` do repositório, para que seu PR possa ser mesclado facilmente.(`git pull origin main`) - c. Você tem mensagens de commit descritivas com um título curto (primeira linha). + c. Você tem mensagens de commit descritivas com um título curto (primeira linha). - d. `make testfull` não gera nenhum erro e possui mais de 90% de _code coverage_. Se ocorrerem erros, corrija-os primeiro e emende seu commit (`git commit --amend`). + d. `make testfull` não gera nenhum erro e possui mais de 90% de *code coverage*. Se ocorrerem erros, corrija-os primeiro e emende seu commit (`git commit --amend`). 3. **Após** essas etapas, você está pronto para abrir um pull request. - a. Dê um título descritivo ao seu PR. + a. Dê um título descritivo ao seu PR. - b. Descreva suas alterações. + b. Descreva suas alterações. - c. Coloque `closes #XXXX` em seu comentário para fechar automaticamente a issue que seu PR corrige (se houver). + c. Coloque `closes #XXXX` em seu comentário para fechar automaticamente a issue que seu PR corrige (se houver). IMPORTANTE: Por favor, revise a paǵina de [COMO CONTRIBUIR ?](https://unb-mds.github.io/2023-2-SuaGradeUnB/contributing/) para obter diretrizes detalhadas sobre contribuições. @@ -28,32 +30,30 @@ IMPORTANTE: Por favor, revise a paǵina de [COMO CONTRIBUIR ?](https://unb-mds.g Por favor, inclua um resumo das alterações e a issue relacionada. Também inclua motivação e contexto relevantes. Liste quaisquer dependências necessárias para essa alteração. -**closes # (issue)** (_caso exista_) +**closes # (issue)** (*caso exista*) ## Tipo de alteração Por favor, exclua as opções que não são relevantes. - -- [ ] Bug fix (alteração que corrige um problema) -- [ ] New feature (alteração que adiciona funcionalidade) -- [ ] Breaking change (correção ou funcionalidade que altera o comportamento de outras partes do sistema de maneira significativa) -- [ ] Documentation update (alteração na documentação) +* \[ ] Bug fix (alteração que corrige um problema) +* \[ ] New feature (alteração que adiciona funcionalidade) +* \[ ] Breaking change (correção ou funcionalidade que altera o comportamento de outras partes do sistema de maneira significativa) +* \[ ] Documentation update (alteração na documentação) # Como isso foi testado? Por favor, descreva os testes que você executou para verificar suas alterações. Forneça instruções para que possamos reproduzir. Liste também quaisquer detalhes relevantes para a configuração de seus testes. -- [ ] Teste A -- [ ] Teste B +* \[ ] Teste A +* \[ ] Teste B # Checklist: -- [ ] Meu código segue as diretrizes de contribuição deste projeto -- [ ] Realizei uma revisão pessoal do meu código -- [ ] Comentei meu código, especialmente em áreas de difícil compreensão -- [ ] Fiz alterações correspondentes na documentação _( se necessário)_ -- [ ] Minhas alterações não geram novos _warnings_ ou erros -- [ ] Adicionei testes que comprovam que minha correção é eficaz ou que minha funcionalidade está funcionando corretamente -- [ ] Testes unitários novos e existentes passam localmente com minhas alterações - +* \[ ] Meu código segue as diretrizes de contribuição deste projeto +* \[ ] Realizei uma revisão pessoal do meu código +* \[ ] Comentei meu código, especialmente em áreas de difícil compreensão +* \[ ] Fiz alterações correspondentes na documentação *( se necessário)* +* \[ ] Minhas alterações não geram novos *warnings* ou erros +* \[ ] Adicionei testes que comprovam que minha correção é eficaz ou que minha funcionalidade está funcionando corretamente +* \[ ] Testes unitários novos e existentes passam localmente com minhas alterações From d7782d8ee64ceaf88523b05442a734eee46e0188 Mon Sep 17 00:00:00 2001 From: GabrielCastelo-31 Date: Sat, 6 Jan 2024 23:16:35 -0300 Subject: [PATCH 3/9] fix codacy issues --- .../pull_request_template.md | 32 +++++++++---------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md index dae2719..b8404f4 100644 --- a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -2,9 +2,9 @@ Por favor, siga estas etapas antes de enviar um PR. -1. Certifique-se de que seu PR não seja duplicado. +1. Certifique-se de que seu PR não seja duplicado. -2. Se não for, então certifique-se de que: +2. Se não for, então certifique-se de que: a. Você fez suas alterações em um branch separado. Os branches DEVEM ter nomes descritivos que comecem com os prefixos `fix/` ou `task`. Bons exemplos são: `fix/signin-issue`,`task/issue-templates` ou `task/add-search-by-name`. @@ -14,7 +14,7 @@ Por favor, siga estas etapas antes de enviar um PR. d. `make testfull` não gera nenhum erro e possui mais de 90% de *code coverage*. Se ocorrerem erros, corrija-os primeiro e emende seu commit (`git commit --amend`). -3. **Após** essas etapas, você está pronto para abrir um pull request. +3. **Após** essas etapas, você está pronto para abrir um pull request. a. Dê um título descritivo ao seu PR. @@ -36,24 +36,24 @@ Por favor, inclua um resumo das alterações e a issue relacionada. Também incl Por favor, exclua as opções que não são relevantes. -* \[ ] Bug fix (alteração que corrige um problema) -* \[ ] New feature (alteração que adiciona funcionalidade) -* \[ ] Breaking change (correção ou funcionalidade que altera o comportamento de outras partes do sistema de maneira significativa) -* \[ ] Documentation update (alteração na documentação) + * \[ ] Bug fix (alteração que corrige um problema) + * \[ ] New feature (alteração que adiciona funcionalidade) + * \[ ] Breaking change (correção ou funcionalidade que altera o comportamento de outras partes do sistema de maneira significativa) + * \[ ] Documentation update (alteração na documentação) # Como isso foi testado? Por favor, descreva os testes que você executou para verificar suas alterações. Forneça instruções para que possamos reproduzir. Liste também quaisquer detalhes relevantes para a configuração de seus testes. -* \[ ] Teste A -* \[ ] Teste B + * \[ ] Teste A + * \[ ] Teste B # Checklist: -* \[ ] Meu código segue as diretrizes de contribuição deste projeto -* \[ ] Realizei uma revisão pessoal do meu código -* \[ ] Comentei meu código, especialmente em áreas de difícil compreensão -* \[ ] Fiz alterações correspondentes na documentação *( se necessário)* -* \[ ] Minhas alterações não geram novos *warnings* ou erros -* \[ ] Adicionei testes que comprovam que minha correção é eficaz ou que minha funcionalidade está funcionando corretamente -* \[ ] Testes unitários novos e existentes passam localmente com minhas alterações + * \[ ] Meu código segue as diretrizes de contribuição deste projeto + * \[ ] Realizei uma revisão pessoal do meu código + * \[ ] Comentei meu código, especialmente em áreas de difícil compreensão + * \[ ] Fiz alterações correspondentes na documentação *( se necessário)* + * \[ ] Minhas alterações não geram novos *warnings* ou erros + * \[ ] Adicionei testes que comprovam que minha correção é eficaz ou que minha funcionalidade está funcionando corretamente + * \[ ] Testes unitários novos e existentes passam localmente com minhas alterações From 0368674ade4702ffb1138decdeb8c3089870dd9d Mon Sep 17 00:00:00 2001 From: GabrielCastelo-31 Date: Sat, 6 Jan 2024 23:39:46 -0300 Subject: [PATCH 4/9] trying one more time --- .../pull_request_template.md | 46 +++++++++---------- 1 file changed, 23 insertions(+), 23 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md index b8404f4..3a36a15 100644 --- a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -2,25 +2,25 @@ Por favor, siga estas etapas antes de enviar um PR. -1. Certifique-se de que seu PR não seja duplicado. +1. Certifique-se de que seu PR não seja duplicado. -2. Se não for, então certifique-se de que: +2. Se não for, então certifique-se de que: - a. Você fez suas alterações em um branch separado. Os branches DEVEM ter nomes descritivos que comecem com os prefixos `fix/` ou `task`. Bons exemplos são: `fix/signin-issue`,`task/issue-templates` ou `task/add-search-by-name`. +a. Você fez suas alterações em um branch separado. Os branches DEVEM ter nomes descritivos que comecem com os prefixos `fix/` ou `task`. Bons exemplos são: `fix/signin-issue`,`task/issue-templates` ou `task/add-search-by-name`. - b. Você sincronizou sua branch com a branch `main` do repositório, para que seu PR possa ser mesclado facilmente.(`git pull origin main`) +b. Você sincronizou sua branch com a branch `main` do repositório, para que seu PR possa ser mesclado facilmente.(`git pull origin main`) - c. Você tem mensagens de commit descritivas com um título curto (primeira linha). +c. Você tem mensagens de commit descritivas com um título curto (primeira linha). - d. `make testfull` não gera nenhum erro e possui mais de 90% de *code coverage*. Se ocorrerem erros, corrija-os primeiro e emende seu commit (`git commit --amend`). +d. `make testfull` não gera nenhum erro e possui mais de 90% de *code coverage*. Se ocorrerem erros, corrija-os primeiro e emende seu commit (`git commit --amend`). -3. **Após** essas etapas, você está pronto para abrir um pull request. +3. **Após** essas etapas, você está pronto para abrir um pull request. - a. Dê um título descritivo ao seu PR. +a. Dê um título descritivo ao seu PR. - b. Descreva suas alterações. +b. Descreva suas alterações. - c. Coloque `closes #XXXX` em seu comentário para fechar automaticamente a issue que seu PR corrige (se houver). +c. Coloque `closes #XXXX` em seu comentário para fechar automaticamente a issue que seu PR corrige (se houver). IMPORTANTE: Por favor, revise a paǵina de [COMO CONTRIBUIR ?](https://unb-mds.github.io/2023-2-SuaGradeUnB/contributing/) para obter diretrizes detalhadas sobre contribuições. @@ -36,24 +36,24 @@ Por favor, inclua um resumo das alterações e a issue relacionada. Também incl Por favor, exclua as opções que não são relevantes. - * \[ ] Bug fix (alteração que corrige um problema) - * \[ ] New feature (alteração que adiciona funcionalidade) - * \[ ] Breaking change (correção ou funcionalidade que altera o comportamento de outras partes do sistema de maneira significativa) - * \[ ] Documentation update (alteração na documentação) +* \[ ] Bug fix (alteração que corrige um problema) +* \[ ] New feature (alteração que adiciona funcionalidade) +* \[ ] Breaking change (correção ou funcionalidade que altera o comportamento de outras partes do sistema de maneira significativa) +* \[ ] Documentation update (alteração na documentação) # Como isso foi testado? Por favor, descreva os testes que você executou para verificar suas alterações. Forneça instruções para que possamos reproduzir. Liste também quaisquer detalhes relevantes para a configuração de seus testes. - * \[ ] Teste A - * \[ ] Teste B +* \[ ] Teste A +* \[ ] Teste B # Checklist: - * \[ ] Meu código segue as diretrizes de contribuição deste projeto - * \[ ] Realizei uma revisão pessoal do meu código - * \[ ] Comentei meu código, especialmente em áreas de difícil compreensão - * \[ ] Fiz alterações correspondentes na documentação *( se necessário)* - * \[ ] Minhas alterações não geram novos *warnings* ou erros - * \[ ] Adicionei testes que comprovam que minha correção é eficaz ou que minha funcionalidade está funcionando corretamente - * \[ ] Testes unitários novos e existentes passam localmente com minhas alterações +* \[ ] Meu código segue as diretrizes de contribuição deste projeto +* \[ ] Realizei uma revisão pessoal do meu código +* \[ ] Comentei meu código, especialmente em áreas de difícil compreensão +* \[ ] Fiz alterações correspondentes na documentação *( se necessário)* +* \[ ] Minhas alterações não geram novos *warnings* ou erros +* \[ ] Adicionei testes que comprovam que minha correção é eficaz ou que minha funcionalidade está funcionando corretamente +* \[ ] Testes unitários novos e existentes passam localmente com minhas alterações From 46cee4f089284e9d56ac86202a3c2171d7d07c59 Mon Sep 17 00:00:00 2001 From: GabrielCastelo-31 Date: Sat, 6 Jan 2024 23:47:09 -0300 Subject: [PATCH 5/9] I hope this is the last try --- .../pull_request_template.md | 32 +++++++++---------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md index 3a36a15..718e935 100644 --- a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -2,9 +2,9 @@ Por favor, siga estas etapas antes de enviar um PR. -1. Certifique-se de que seu PR não seja duplicado. +1. Certifique-se de que seu PR não seja duplicado. -2. Se não for, então certifique-se de que: +2. Se não for, então certifique-se de que: a. Você fez suas alterações em um branch separado. Os branches DEVEM ter nomes descritivos que comecem com os prefixos `fix/` ou `task`. Bons exemplos são: `fix/signin-issue`,`task/issue-templates` ou `task/add-search-by-name`. @@ -14,7 +14,7 @@ c. Você tem mensagens de commit descritivas com um título curto (primeira linh d. `make testfull` não gera nenhum erro e possui mais de 90% de *code coverage*. Se ocorrerem erros, corrija-os primeiro e emende seu commit (`git commit --amend`). -3. **Após** essas etapas, você está pronto para abrir um pull request. +3. **Após** essas etapas, você está pronto para abrir um pull request. a. Dê um título descritivo ao seu PR. @@ -36,24 +36,24 @@ Por favor, inclua um resumo das alterações e a issue relacionada. Também incl Por favor, exclua as opções que não são relevantes. -* \[ ] Bug fix (alteração que corrige um problema) -* \[ ] New feature (alteração que adiciona funcionalidade) -* \[ ] Breaking change (correção ou funcionalidade que altera o comportamento de outras partes do sistema de maneira significativa) -* \[ ] Documentation update (alteração na documentação) +* \[ ] Bug fix (alteração que corrige um problema) +* \[ ] New feature (alteração que adiciona funcionalidade) +* \[ ] Breaking change (correção ou funcionalidade que altera o comportamento de outras partes do sistema de maneira significativa) +* \[ ] Documentation update (alteração na documentação) # Como isso foi testado? Por favor, descreva os testes que você executou para verificar suas alterações. Forneça instruções para que possamos reproduzir. Liste também quaisquer detalhes relevantes para a configuração de seus testes. -* \[ ] Teste A -* \[ ] Teste B +* \[ ] Teste A +* \[ ] Teste B # Checklist: -* \[ ] Meu código segue as diretrizes de contribuição deste projeto -* \[ ] Realizei uma revisão pessoal do meu código -* \[ ] Comentei meu código, especialmente em áreas de difícil compreensão -* \[ ] Fiz alterações correspondentes na documentação *( se necessário)* -* \[ ] Minhas alterações não geram novos *warnings* ou erros -* \[ ] Adicionei testes que comprovam que minha correção é eficaz ou que minha funcionalidade está funcionando corretamente -* \[ ] Testes unitários novos e existentes passam localmente com minhas alterações +* \[ ] Meu código segue as diretrizes de contribuição deste projeto +* \[ ] Realizei uma revisão pessoal do meu código +* \[ ] Comentei meu código, especialmente em áreas de difícil compreensão +* \[ ] Fiz alterações correspondentes na documentação *( se necessário)* +* \[ ] Minhas alterações não geram novos *warnings* ou erros +* \[ ] Adicionei testes que comprovam que minha correção é eficaz ou que minha funcionalidade está funcionando corretamente +* \[ ] Testes unitários novos e existentes passam localmente com minhas alterações From 8ea4203d843bccf6fe0fc297115cddc4b9d859e6 Mon Sep 17 00:00:00 2001 From: GabrielCastelo-31 Date: Sun, 7 Jan 2024 00:03:55 -0300 Subject: [PATCH 6/9] trying --- .../pull_request_template.md | 26 +++++++++---------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md index 718e935..089fc39 100644 --- a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -36,24 +36,24 @@ Por favor, inclua um resumo das alterações e a issue relacionada. Também incl Por favor, exclua as opções que não são relevantes. -* \[ ] Bug fix (alteração que corrige um problema) -* \[ ] New feature (alteração que adiciona funcionalidade) -* \[ ] Breaking change (correção ou funcionalidade que altera o comportamento de outras partes do sistema de maneira significativa) -* \[ ] Documentation update (alteração na documentação) +* \[ ] Bug fix (alteração que corrige um problema) +* \[ ] New feature (alteração que adiciona funcionalidade) +* \[ ] Breaking change (correção ou funcionalidade que altera o comportamento de outras partes do sistema de maneira significativa) +* \[ ] Documentation update (alteração na documentação) # Como isso foi testado? Por favor, descreva os testes que você executou para verificar suas alterações. Forneça instruções para que possamos reproduzir. Liste também quaisquer detalhes relevantes para a configuração de seus testes. -* \[ ] Teste A -* \[ ] Teste B +* \[ ] Teste A +* \[ ] Teste B # Checklist: -* \[ ] Meu código segue as diretrizes de contribuição deste projeto -* \[ ] Realizei uma revisão pessoal do meu código -* \[ ] Comentei meu código, especialmente em áreas de difícil compreensão -* \[ ] Fiz alterações correspondentes na documentação *( se necessário)* -* \[ ] Minhas alterações não geram novos *warnings* ou erros -* \[ ] Adicionei testes que comprovam que minha correção é eficaz ou que minha funcionalidade está funcionando corretamente -* \[ ] Testes unitários novos e existentes passam localmente com minhas alterações +* \[ ] Meu código segue as diretrizes de contribuição deste projeto +* \[ ] Realizei uma revisão pessoal do meu código +* \[ ] Comentei meu código, especialmente em áreas de difícil compreensão +* \[ ] Fiz alterações correspondentes na documentação *( se necessário)* +* \[ ] Minhas alterações não geram novos *warnings* ou erros +* \[ ] Adicionei testes que comprovam que minha correção é eficaz ou que minha funcionalidade está funcionando corretamente +* \[ ] Testes unitários novos e existentes passam localmente com minhas alterações From cea1032bf526d29b701d9affd185b7e13d276480 Mon Sep 17 00:00:00 2001 From: GabrielCastelo-31 Date: Sun, 7 Jan 2024 00:09:51 -0300 Subject: [PATCH 7/9] trying again --- .../pull_request_template.md | 28 +++++++++---------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md index 089fc39..7a5ade6 100644 --- a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -30,30 +30,30 @@ IMPORTANTE: Por favor, revise a paǵina de [COMO CONTRIBUIR ?](https://unb-mds.g Por favor, inclua um resumo das alterações e a issue relacionada. Também inclua motivação e contexto relevantes. Liste quaisquer dependências necessárias para essa alteração. -**closes # (issue)** (*caso exista*) +**closes # (issue)** (_caso exista_) ## Tipo de alteração Por favor, exclua as opções que não são relevantes. -* \[ ] Bug fix (alteração que corrige um problema) -* \[ ] New feature (alteração que adiciona funcionalidade) -* \[ ] Breaking change (correção ou funcionalidade que altera o comportamento de outras partes do sistema de maneira significativa) -* \[ ] Documentation update (alteração na documentação) +- \[ ] Bug fix (alteração que corrige um problema) +- \[ ] New feature (alteração que adiciona funcionalidade) +- \[ ] Breaking change (correção ou funcionalidade que altera o comportamento de outras partes do sistema de maneira significativa) +- \[ ] Documentation update (alteração na documentação) # Como isso foi testado? Por favor, descreva os testes que você executou para verificar suas alterações. Forneça instruções para que possamos reproduzir. Liste também quaisquer detalhes relevantes para a configuração de seus testes. -* \[ ] Teste A -* \[ ] Teste B +- \[ ] Teste A +- \[ ] Teste B # Checklist: -* \[ ] Meu código segue as diretrizes de contribuição deste projeto -* \[ ] Realizei uma revisão pessoal do meu código -* \[ ] Comentei meu código, especialmente em áreas de difícil compreensão -* \[ ] Fiz alterações correspondentes na documentação *( se necessário)* -* \[ ] Minhas alterações não geram novos *warnings* ou erros -* \[ ] Adicionei testes que comprovam que minha correção é eficaz ou que minha funcionalidade está funcionando corretamente -* \[ ] Testes unitários novos e existentes passam localmente com minhas alterações +- \[ ] Meu código segue as diretrizes de contribuição deste projeto +- \[ ] Realizei uma revisão pessoal do meu código +- \[ ] Comentei meu código, especialmente em áreas de difícil compreensão +- \[ ] Fiz alterações correspondentes na documentação _( se necessário)_ +- \[ ] Minhas alterações não geram novos _warnings_ ou erros +- \[ ] Adicionei testes que comprovam que minha correção é eficaz ou que minha funcionalidade está funcionando corretamente +- \[ ] Testes unitários novos e existentes passam localmente com minhas alterações From 196498a4fbc7d89b15ba91f056ab1de84438d27c Mon Sep 17 00:00:00 2001 From: GabrielCastelo-31 Date: Sun, 7 Jan 2024 20:00:28 -0300 Subject: [PATCH 8/9] Add comment blocks and fix minor text issues --- .../pull_request_template.md | 54 +++++++++---------- 1 file changed, 27 insertions(+), 27 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md index 7a5ade6..295c1dc 100644 --- a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -1,10 +1,10 @@ -## Modelo de Solicitação de Pull Request + # Descrição -Por favor, inclua um resumo das alterações e a issue relacionada. Também inclua motivação e contexto relevantes. Liste quaisquer dependências necessárias para essa alteração. + + ## Tipo de alteração -Por favor, exclua as opções que não são relevantes. + -- \[ ] Bug fix (alteração que corrige um problema) -- \[ ] New feature (alteração que adiciona funcionalidade) -- \[ ] Breaking change (correção ou funcionalidade que altera o comportamento de outras partes do sistema de maneira significativa) -- \[ ] Documentation update (alteração na documentação) +* \[ ] Bug fix (alteração que corrige um problema) +* \[ ] New feature (alteração que adiciona funcionalidade) +* \[ ] Breaking change (correção ou funcionalidade que altera o comportamento de outras partes do sistema de maneira significativa) +* \[ ] Documentation update (alteração na documentação) -# Como isso foi testado? +## Como isso foi testado? -Por favor, descreva os testes que você executou para verificar suas alterações. Forneça instruções para que possamos reproduzir. Liste também quaisquer detalhes relevantes para a configuração de seus testes. + -- \[ ] Teste A -- \[ ] Teste B +* \[ ] Teste A +* \[ ] Teste B -# Checklist: +## Checklist -- \[ ] Meu código segue as diretrizes de contribuição deste projeto -- \[ ] Realizei uma revisão pessoal do meu código -- \[ ] Comentei meu código, especialmente em áreas de difícil compreensão -- \[ ] Fiz alterações correspondentes na documentação _( se necessário)_ -- \[ ] Minhas alterações não geram novos _warnings_ ou erros -- \[ ] Adicionei testes que comprovam que minha correção é eficaz ou que minha funcionalidade está funcionando corretamente -- \[ ] Testes unitários novos e existentes passam localmente com minhas alterações +* \[ ] Meu código segue as diretrizes de contribuição deste projeto +* \[ ] Realizei uma revisão pessoal do meu código +* \[ ] Comentei meu código, especialmente em áreas de difícil compreensão +* \[ ] Fiz alterações correspondentes na documentação +* \[ ] Minhas alterações não geram novos *warnings* ou erros +* \[ ] Adicionei testes que comprovam que minha correção é eficaz ou que minha funcionalidade está funcionando corretamente +* \[ ] Testes unitários novos e existentes passam localmente com minhas alterações From b209a8a232db082d649979aef32cef3e3cf27742 Mon Sep 17 00:00:00 2001 From: GabrielCastelo-31 Date: Sun, 7 Jan 2024 20:21:31 -0300 Subject: [PATCH 9/9] Add more intructions for PR contributions --- .../pull_request_template.md | 20 +++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md index 295c1dc..b4832cf 100644 --- a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -30,30 +30,34 @@ IMPORTANTE: Por favor, revise a paǵina de "COMO CONTRIBUIR?" (https://unb-mds.g + ## Tipo de alteração -* \[ ] Bug fix (alteração que corrige um problema) -* \[ ] New feature (alteração que adiciona funcionalidade) -* \[ ] Breaking change (correção ou funcionalidade que altera o comportamento de outras partes do sistema de maneira significativa) -* \[ ] Documentation update (alteração na documentação) +* \[ ] **Bug fix** (alteração que corrige um problema) +* \[ ] **New feature** (alteração que adiciona funcionalidade) +* \[ ] **Breaking change** (correção ou funcionalidade que altera o comportamento de outras partes do sistema de maneira significativa) +* \[ ] **Documentation update** (alteração na documentação) ## Como isso foi testado? - + * \[ ] Teste A * \[ ] Teste B ## Checklist + + * \[ ] Meu código segue as diretrizes de contribuição deste projeto * \[ ] Realizei uma revisão pessoal do meu código * \[ ] Comentei meu código, especialmente em áreas de difícil compreensão -* \[ ] Fiz alterações correspondentes na documentação +* \[ ] Fiz alterações correspondentes na documentação * \[ ] Minhas alterações não geram novos *warnings* ou erros -* \[ ] Adicionei testes que comprovam que minha correção é eficaz ou que minha funcionalidade está funcionando corretamente -* \[ ] Testes unitários novos e existentes passam localmente com minhas alterações +* \[ ] Adicionei testes que comprovam que minha correção é eficaz ou que minha funcionalidade está funcionando corretamente +* \[ ] Todos os testes unitários novos e existentes passam localmente com minhas alterações