-
Notifications
You must be signed in to change notification settings - Fork 56
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
📝 Corrigir apontamentos feitos por Daniel durante o review
[skip ci] * Mover os arquivos para a pasta `docs/` * Adicionar link para o arquivo de contribuicao no README.md * Adicionar o arquivo de licensa MIT:memo: Corrigir apontamentos feitos por Daniel durante o review
- Loading branch information
1 parent
0728e3f
commit 56ba4a5
Showing
7 changed files
with
101 additions
and
49 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,29 +1,43 @@ | ||
<!-- | ||
Já leu nosso codigo de conduta? Ao abrir uma Issue, é esperado que você tenha concordado com os termos descritos lá. | ||
* Este é um modelo de Issue e serve para guiar a pessoa colaboradora que deseja relatar algum **bug** ou **melhoria** no projeto ***Verdade Seja Dita***. | ||
* Caso você não veja necessidade ou sentido em descrever algum tópico, coloque algo como: "Não aplicável". | ||
* Ao abrir uma Issue, é esperado que você tenha concordado com os termos descritos no nosso [código de conduta](CODE_OF_CONDUCT.md). | ||
--> | ||
|
||
### Descrição | ||
|
||
[Descrição do Issue] | ||
<!--[Descrição do Bug ou da Melhoria]--> | ||
|
||
### Passos para reproduzir | ||
<!-- **(opcional, em caso de melhoria)** --> | ||
|
||
### Passos para reproduzir | ||
<!-- | ||
1. [Primeiro Passo] | ||
2. [Segundo Passo] | ||
3. [etc...] | ||
**Comportamento esperado:** [O que você esperava que acontecesse] | ||
--> | ||
|
||
**Comportamento esperado:** <!--[O que você esperava que acontecesse]--> | ||
|
||
**Comportamento atual:** <!--[O que realmente acontece]--> | ||
|
||
**Frequência que isso acontece:** <!--[Qual porcentagem do tempo que o bug é reproduzido?]--> | ||
|
||
### Sugestão de melhoria | ||
<!-- **(opcional, em caso de bug)** --> | ||
|
||
**Comportamento atual:** [O que realmente acontece] | ||
**Motivação:** <!--[Como surgiu a necessidade/oportunidade para tal melhoria?]--> | ||
|
||
**Qual frequência que isso acontece:** [Qual porcentagem do tempo se reproduz?] | ||
**Comportamentos a serem afetados:** <!--[Se algum comportamento será afetado, descreva quais e como]--> | ||
|
||
### Versoes | ||
### Versões | ||
|
||
Por favor inclua o nome e a versão do browser que você reproduziu o bug. | ||
<!--Por favor inclua o nome e a versão do browser que você reproduziu o bug ou sente necessidade da melhoria.--> | ||
|
||
### Informação adicional | ||
|
||
Qualquer informação adicional, configuração ou dados que possam ser necessários para reproduzir o problema. | ||
<!--Qualquer informação adicional, configuração ou dados que possam ser necessários para reproduzir o problema ou esclarecer a melhoria.--> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,33 +1,44 @@ | ||
<!-- | ||
* Este é um modelo de Pull Request(PR) e serve para guiar a pessoa colaboradora que deseja submeter mudanças no projeto ***Verdade Seja Dita***. | ||
* Caso você não veja necessidade ou sentido em descrever algum tópico, coloque algo como: "Não aplicável". | ||
* Ao abrir uma Issue, é esperado que você tenha concordado com os termos descritos no nosso [código de conduta](CODE_OF_CONDUCT.md). | ||
--> | ||
|
||
### Requisitos | ||
|
||
* É necessário preencher o modelo. Um PR que não inclua informações suficientes para ser revisado em tempo hábil, pode dificultar a revisão dos mantenedores/colaboradores. | ||
* Todo o código novo requer testes para evitar regressões | ||
<!-- | ||
* Um Pull Request(PR) que não inclua informações suficientes para ser revisado em tempo hábil(cerca 24h), pode dificultar o andamento das pessoas que mantém ou colaboram no projeto. | ||
* Todo o código novo requer testes para evitar regressões: executando `yarn test-coverage` para ver a cobertura de testes do seu código | ||
* Todos os testes unitários devem estar funcionando: rode `yarn test` para executar os testes unitários | ||
* Passar todas as regras de linter/eslint: rode `yarn lint` para executar a análise de código | ||
* Seguir as boas práticas de desenvolvimento de código | ||
--> | ||
|
||
### Descrição da Mudança | ||
|
||
<!-- | ||
Devemos ser capazes de entender a abordagem da sua mudança a partir desta descrição. Se não tivermos uma boa idéia do que o código fará a partir da descrição aqui, o PR pode ser revisado com dificuldade. | ||
Tenha em mente que o mantenedor/colaborador que revisa este PR pode não estar familiarizado não ter trabalhado com o código recentemente, então, seja claro. | ||
* Devemos ser capazes de entender a abordagem da sua mudança a partir desta descrição. Se não tivermos uma boa idéia do que o código fará a partir da descrição aqui, o Pull Request(PR) pode ser revisado com dificuldade. | ||
* Tenha em mente que a pessoa mantenedora/colaboradora a cargo de revisar este PR pode não estar familiarizado(a) ou não ter trabalhado com o código recentemente, então, seja claro(a). | ||
--> | ||
|
||
### Benefícios | ||
|
||
<! - Quais benefícios serão realizados pela mudança de código? -> | ||
|
||
### Possíveis Desvantagens | ||
|
||
<! - Quais são os possíveis efeitos colaterais ou impactos negativos da mudança de código? -> | ||
<!-- Quais benefícios serão realizados pela mudança de código? --> | ||
|
||
### Possíveis Desvantagens | ||
|
||
<! - Quais são os possíveis efeitos colaterais ou impactos negativos da mudança de código? -> | ||
<!-- Quais são os possíveis efeitos colaterais ou impactos negativos da mudança de código? --> | ||
|
||
### Issues relacionados | ||
|
||
<! - Informe quaisquer Issues relacionados aqui -> | ||
<!-- Informe quaisquer Issues relacionados aqui --> | ||
|
||
### Abordagens Alternativas | ||
|
||
<! - Explique quais outras alternativas foram considerados e por que a versão proposta foi selecionada -> | ||
<!-- Explique quais outras alternativas foram considerados e por que a versão proposta foi selecionada --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
Antes de abrir um Issue, por favor, reveja o nosso [guia de contribuição][CONTRIBUTING.md]. |
Oops, something went wrong.