Skip to content

Commit

Permalink
📝 Corrigir apontamentos feitos por Daniel durante o review
Browse files Browse the repository at this point in the history
[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
Karla Falcão authored and karlafalcao committed Jan 12, 2018
1 parent 0728e3f commit 56ba4a5
Show file tree
Hide file tree
Showing 7 changed files with 101 additions and 49 deletions.
14 changes: 7 additions & 7 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Convenção de Código de Conduta do Contribuidor
# Código de Conduta da Pessoa Contribuidora

## Nosso Comprometimento

Na intenção de promover um ambiente aberto e acolhedor, nós como contribuidores e mantenedores nos comprometemos em fazer com que a participação no nosso projeto e na nossa comunidade seja livre de experiência de assédio para todos, independente da idade, formato do corpo, deficiência, etnia, identidade e expressão de gênero, nível de experiência, nacionalidade, aparência pessoal, raça, religião, ou identidade e orientação sexual.
Na intenção de promover um ambiente aberto e acolhedor, nós como pessoas contribuidoras e mantenedoras nos comprometemos em fazer com que a participação no nosso projeto e na nossa comunidade seja livre de experiência de assédio para todos, independente da idade, formato do corpo, deficiência, etnia, identidade e expressão de gênero, nível de experiência, nacionalidade, aparência pessoal, raça, religião, ou identidade e orientação sexual.

## Nossos Termos

Expand All @@ -25,17 +25,17 @@ Exemplos de comportamentos **inaceitáveis** incluem:

## Nossas responsabilidades

Os responsáveis ​​pelo projeto são responsáveis ​​por esclarecer os padrões de comportamento aceitável e devem tomar medidas corretivas apropriadas e justas em resposta a qualquer instância de comportamento inaceitável.
As pessoas responsáveis pelo projeto são encarregadas de esclarecer os padrões de comportamento aceitávéis e devem tomar medidas corretivas apropriadas e justas em resposta a qualquer instância de comportamento inaceitável.

Os mantenedores do projeto têm o direito e a responsabilidade de remover, editar ou rejeitar comentários, compromissos, códigos, edições de wiki, problemas e outras contribuições que não estejam alinhados com este Código de Conduta, que eles considerem inapropriado, ameaçador, ofensivo ou prejudicial.
As pessoas que mantém o projeto têm o direito e a responsabilidade de remover, editar ou rejeitar comentários, compromissos, códigos, edições de wiki, problemas e outras contribuições que não estejam alinhados com este Código de Conduta, que eles considerem inapropriado, ameaçador, ofensivo ou prejudicial.

## Escopo

Este Código de Conduta aplica tanto nos espaços do projeto quanto nos espaços públicos quando um indivíduo representa o projeto ou sua comunidade. Exemplos de representar um projeto ou comunidade incluem o uso de um endereço de e-mail oficial do projeto, postagem através de uma conta oficial de mídias sociais, ou atuando como representante designado em um evento online ou offline. A representação de um projeto pode ser melhor definida e esclarecida pelos responsáveis ​​pelo projeto.
Este Código de Conduta aplica tanto nos espaços do projeto quanto nos espaços públicos quando um indivíduo representa o projeto ou sua comunidade. Exemplos de representar um projeto ou comunidade incluem o uso de um endereço de e-mail oficial do projeto, postagem através de uma conta oficial de mídias sociais, ou atuando como representante designado em um evento online ou offline. A representação de um projeto pode ser melhor definida e esclarecida pelas pessoas responsáveis ​​pelo projeto.

## Cumprimento

Qualquer comportamento não gerenciável pode ser relatado entrando em contato com a equipe do projeto em [Coletivo Enegrecer] (https://gitter.im/Coletivo-Enegrecer/Enegrecer). Todas as queixas serão revistas e investigadas e resultarão em uma resposta considerada necessária e adequada às circunstâncias. A equipe do projeto é obrigada a manter a confidencialidade em relação ao denunciante de um incidente. Mais detalhes sobre políticas de execução específicas podem ser publicados separadamente.
Qualquer comportamento não gerenciável pode ser relatado entrando em contato com a equipe do projeto [Coletivo Enegrecer - Verdade Seja Dita](https://gitter.im/Coletivo-Enegrecer/Enegrecer). Todas as queixas serão revistas e investigadas e resultarão em uma resposta considerada necessária e adequada às circunstâncias. A equipe do projeto é obrigada a manter a confidencialidade em relação ao denunciante de um incidente. Mais detalhes sobre políticas de execução específicas podem ser publicados separadamente.

Os mantenedores do projeto que não seguem ou aplicam o Código de Conduta de boa fé podem enfrentar repercussões temporárias ou permanentes, conforme determinado por outros membros da liderança do projeto.
As pessoas que mantém o projeto que não seguem ou aplicam o Código de Conduta de boa fé podem enfrentar repercussões temporárias ou permanentes, conforme determinado por outros membros da liderança do projeto.

41 changes: 21 additions & 20 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
# Como contribuir no ***Verdade Seja Dita***

# Como contribuir no **Verdade Seja Dita**

:+1::tada: Antes de tudo, obrigada por contribuir no nosso projeto! :tada::+1:


Aqui você vai encontrar uma série de guias para contribuir no site **Verdade Seja Dita**, que está hosteado no Github.
Aqui você vai encontrar uma série de guias para contribuir no projeto **Verdade Seja Dita**, que está hosteado no Github.
Veja essas linhas mais como guias do que regras.
Use seu melhor julgamento, e sinta se livre para propor mudancas neste documento em um Pull Request.

Expand All @@ -19,35 +18,35 @@ Use seu melhor julgamento, e sinta se livre para propor mudancas neste documento
* [Pull Requests](#pull-requests)

[Guias de Estilo](#styleguides)
* [Guia de Estilo para Messagens de Commit](#guia-de-estilo-para-mensagens-de-commit)
* [Guia de Estilo para Mensagens de Commit](#guia-de-estilo-para-mensagens-de-commit)
* [Guia de Estilo para JavaScript/React](#guia-de-estilo-para-javascript)
* [Guia de Estilo para Testes](#guia-de-estilo-de-testes)

## Código de Conduta

Esse projeto e todos os participantes são governados pelo [Código de conduta - Verdade Seja Dita](CODE_OF_CONDUCT.md). Se deseja participar, é esperado que você concorde com o Código.
Esse projeto e todos os participantes são guiados pelo [código de conduta do projeto **Verdade Seja dita**](CODE_OF_CONDUCT.md). Se deseja participar, significa que você está de acordo com o nosso código de conduta.

## Como eu posso Contribuir?

### Reportando Bugs

Esta seção guiará a pessoa que deseja contribuir reportando bugs do Site Verdade Seja Dita. Seguindo esse guia você ajudará os mantenedores e a comunidade a entender o seu reporte :pencil:, reproduzir o comportamento :computer: :computer:, e encontrar reportes relacionados :mag_right:.
Esta seção guiará a pessoa que deseja contribuir reportando bugs do Site Verdade Seja Dita. Seguindo esse guia você ajudará as pessoas que mantém o projeto e a comunidade a entender o seu reporte :pencil:, reproduzir o comportamento :computer: :computer:, e encontrar reportes relacionados :mag_right:.

Antes de reportar bugs, por favor dê uma olhada [nessa lista](#antes-de-reportar-um-bug) pra checar se você realmente precisa reportar o bug. Quando você estiver reportando um bug, por favor [inclua o máximo de detalhes possível](#como-fazer-um-bom-report-de-bug). Preencha o [template](ISSUE_TEMPLATE.md), as informações pedidas nos ajudam a resolver rápido os problemas.

> **Nota:** Se você encontrar um issue **Fechado** que parece ser o mesmo problema que você está enfrentando, abra um novo issue e inclua um link para o issue original no corpo do seu novo.
#### Antes de Reportar um Bug

* **Execute uma [pesquisa rápida](https://github.com/search?q=+is%3Aissue+user%3Aatom)** para ver se o problema já foi relatado. Se o issue foi relatado e **ainda estiver aberto **, adicione um comentário no issue existente em vez de abrir um novo.
* **Execute uma [pesquisa rápida](https://github.com/search?q=+is%3Aissue+user%3Aatom)** para ver se o problema já foi relatado. Se o Issue foi relatado e **ainda estiver aberto**, adicione um comentário no issue existente em vez de abrir um novo.
* **Limpe a cache do seu navegador**
* **Tente reproduzir o comportamento em outros navegadores**

#### Como fazer um (Bom) reporte de Bug?

Bugs são acompanhados através de [issues do GitHub](https://guides.github.com/features/issues/). Forneça as seguintes informações preenchendo [o template](ISSUE_TEMPLATE.md).

Explique o problema e inclua detalhes adicionais para ajudar os mantenedores a reproduzir o problema:
Explique o problema e inclua detalhes adicionais para ajudar as pessoas que mantém o projeto a reproduzir o problema:

* **Use um título claro e descritivo** para a questão para identificar o problema.
* **Descreva os passos exatos que reproduzem o problema** em tantos detalhes quanto possível. Por exemplo, comece explicando como você iniciou o Verdade Seja Dita, p.Ex. através de um link ou digitando o endereço no browser. Ao listar as etapas, **não apenas diga o que fez, mas explique como você fez isso**. Por exemplo, se você moveu o cursor para um campo do form, explique se você usou o mouse, ou um atalho de teclado, em caso afirmativo, qual deles?
Expand All @@ -73,7 +72,7 @@ Inclua detalhes sobre sua configuração e ambiente:

### Sugerindo Melhorias

Esta seção visa guiar você a submeter uma sugestão de melhoria para o Site Verdade Seja Dita, incluindo novas funcionalidades e pequenas melhorias a existentes. Ao seguir essas diretrizes você ajudará os mantenedores e a comunidade a entender sua sugestão :pencil: e encontrar sugestões relacionadas :mag_right:
Esta seção visa guiar você a submeter uma sugestão de melhoria para o Site Verdade Seja Dita, incluindo novas funcionalidades e pequenas melhorias às existentes. Ao seguir essas diretrizes você ajudará as pessoas que mantém o projeto e a comunidade a entender sua sugestão :pencil: e encontrar sugestões relacionadas :mag_right:

Antes de criar suas sugestões de melhorias, por favor de uma olhada [nessa lista](#antes-de-submeter-uma-sugestao-de-melhoria) pra checar se você realmente precisa criar uma. Quando você tiver sugerindo algo, por favor [inclua o máximo de detalhes possível](#como-fazer-um-bom-report-de-bug). Preencha o [template](ISSUE_TEMPLATE.md), incluindo os passos que você imaginaria tomar se a funcionalidade que está pedindo já existisse.

Expand All @@ -96,13 +95,17 @@ Melhorias são acompanhadas através de [issues do GitHub](https://guides.github

#### Desenvolvimento local

O código mais atual em desenvolvimento é acompanhado através da branch **development**. Idealmente, os pedidos de alteração de código devem ser feitos a partir dessa branch, salvo em casos de HotFix ou Documentação.

### Pull Requests

* Preencha [o modelo necessário](PULL_REQUEST_TEMPLATE.md)
* Crie um Fork do projeto e suba as alterações para branch **development** do seu fork
* Abra um Pull request comparando as branchs development (repo original versus seu fork)
* Preencha [o modelo guia](PULL_REQUEST_TEMPLATE.md)
* Não inclua números de Issues no título do PR
* Inclua capturas de tela e GIFs animados em seus PRs sempre que possível.
* Siga o guia de estilo [JavaScript](#javascript-styleguide).
* Os testes unitários seguem a especificacao [Jasmine](https://jasmine.github.io/). Veja o [Guia de Estilo para Testes](#specs-styleguide) abaixo.
* Os testes unitários seguem a especificação do [Jasmine](https://jasmine.github.io/). Veja o [Guia de Estilo para Testes](#specs-styleguide).
* Finalize todos os arquivos com uma nova linha
* Evite o código dependente de um(a) browser/plataforma específico(a)
* Coloque os imports na seguinte ordem:
Expand All @@ -113,34 +116,32 @@ Melhorias são acompanhadas através de [issues do GitHub](https://guides.github

## Guias de Estilo


### Guia de Estilo para Messagens de Commit
### Guia de Estilo para Mensagens de Commit

* Use o tempo presente ("Adicionar recurso" não "Função adicionada")
* Use o modo imperativo ("Mover o cursor para ..." não "Move o cursor para ...")
* Limite a primeira linha a 72 caracteres ou menos
* Referencie Issues e PRs livremente depois da primeira linha
* Quando apenas alterar a documentação, inclua `[ci skip]` na descrição do Commit
* Quando apenas alterar a documentação, inclua a tag `[skip ci]` na descrição do Commit, para que o serviço de CI não seja executado
* Considere começar a mensagem de Commit com um emoji aplicável:
* :art: `:art:` quando melhorar o formato/estrutura do código
* :racehorse: `:racehorse:` quando melhorar o desempenho
* :non-potable_water: `:non-potable_water:` when plugging memory leaks
* :memo: `:memo:` ao escrever documentos
* :bug: `:bug:` quando corrigir um bug
* :fire: `:fire:` quando remover códigos ou arquivos
* :green_heart: `:green_heart:` quando corrigir a CI-Build
* :green_heart: `:green_heart:` quando corrigir a build da CI
* :white_check_mark: `:white_check_mark:` ao adicionar testes
* :lock: `:lock:` quando se trata de segurança
* :arrow_up: `:arrow_up:` ao atualizar dependências
* :arrow_down: `:arrow_down:` ao diminuir dependências
* :shirt: `:shirt:` ao remover avisos de linter
* :shirt: `:shirt:` ao remover avisos de linter/eslint/..


### Guia de Estilo para JavaScript

Todo o código Javascript deve aderir ao [JavaScript Standard Style](https://standardjs.com/).

* Prefira o spread operador do objeto (`{...anotherObj}`) ao inves de `Object.assign()`
* Prefira o spread operador do objeto (`{...anotherObj}`) ao invés de `Object.assign()`
* Coloque o `export` na mesma linha da delaracão sempre que possível
```js
// Use isso:
Expand All @@ -157,7 +158,7 @@ Todo o código Javascript deve aderir ao [JavaScript Standard Style](https://sta

### Guia de Estilo para Testes

- Os testes unitários seguem a especificacao [Jasmine](https://jasmine.github.io/) e geralmente estão na mesma pasta do arquivo que você pretende testar com a extensão `<arquivo>.test.js`.
- Os testes unitários seguem a especificação do [Jasmine](https://jasmine.github.io/) e geralmente estão na mesma pasta do arquivo que você pretende testar com a extensão `<arquivo>.test.js`.
- Trate `describe` como um substantivo ou situação.
- Trate `it` como uma declaração sobre o estado ou como uma operação muda de estado.

Expand All @@ -167,7 +168,7 @@ Todo o código Javascript deve aderir ao [JavaScript Standard Style](https://sta
describe('um cachorro', () =>
it('late', () =>
// teste aqui
describe( 'quando o cachorro está feliz', () =>
describe('quando o cachorro está feliz', () =>
it('abana o rabo', () =>
// teste aqui
```
34 changes: 24 additions & 10 deletions .github/ISSUE_TEMPLATE.md
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.-->
35 changes: 23 additions & 12 deletions .github/PULL_REQUEST_TEMPLATE.md
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 -->
1 change: 1 addition & 0 deletions .github/SUPPORT.md
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].
Loading

0 comments on commit 56ba4a5

Please sign in to comment.