Commit 204f749063f10309db5217022cb18fc7f1a9a280

Authored by Éber Freitas Dias
1 parent 6fb6f45f
Exists in master

Typos e ajustes;

Refs portabilis/i-educar#201

- Limita linhas em 80 caracteres no CONTRIBUTING.md
- Typo em outros.md
Showing 2 changed files with 124 additions and 41 deletions   Show diff stats
.github/ISSUE_TEMPLATE/outros.md
... ... @@ -11,7 +11,7 @@ o template abaixo para preencher sua issue:
11 11  
12 12 **CONTEXTO:**
13 13  
14   -Porque esta alteração é importante? Como você usaria isto? Como esta alteração
  14 +Por que esta alteração é importante? Como você usaria isto? Como esta alteração
15 15 pode beneficiar outros usuários?
16 16  
17 17 **IMPLEMENTAÇÃO:**
... ...
CONTRIBUTING.md
1 1 # Guia de contribuição
2 2  
3   -Que bom que você resolveu contribuir conosco. Obrigado! A proposta do i-Educar é ambiciosa e precisamos de toda ajuda possível para alcançar nossos objetivos. Neste guia vamos explicar como funcionam os nossos processos internos e como podemos trabalhar juntos da melhor forma possível.
  3 +Que bom que você resolveu contribuir conosco. Obrigado! A proposta do i-Educar é
  4 +ambiciosa e precisamos de toda ajuda possível para alcançar nossos objetivos.
  5 +Neste guia vamos explicar como funcionam os nossos processos internos e como
  6 +podemos trabalhar juntos da melhor forma possível.
4 7  
5 8 ## Como contribuir
6 9  
... ... @@ -15,17 +18,27 @@ Existem diversas formas de contribuir com o projeto:
15 18  
16 19 ### Reportando bugs
17 20  
18   -Se encontrou um bug no i-Educar você pode reportá-lo usando a ferramenta de [issues do GitHub](https://github.com/portabilis/i-educar/issues). Porém antes de enviar seu bug é importante fazer as seguintes verificações:
  21 +Se encontrou um bug no i-Educar você pode reportá-lo usando a ferramenta de
  22 +[issues do GitHub](https://github.com/portabilis/i-educar/issues). Porém antes
  23 +de enviar seu bug é importante fazer as seguintes verificações:
19 24  
20   -1. Atualize seu repositório local no branch `master` mais recente. Talvez seu bug já tenha sido corrigido na versão mais recente;
21   -2. Verifique se o bug já foi reportado por outra pessoa fazendo uma busca pelas issues.
  25 +1. Atualize seu repositório local no branch `master` mais recente. Talvez seu
  26 + bug já tenha sido corrigido na versão mais recente;
  27 +2. Verifique se o bug já foi reportado por outra pessoa fazendo uma busca pelas
  28 + issues.
22 29  
23   -Se o bug realmente não foi resolvido ou acolhido então está na hora de [criar uma nova issue](https://github.com/portabilis/i-educar/issues/new). No título da issue tente resumir da melhor forma o problema evitando títulos genéricos como *"Falha no sistema"* ou *"Problemas na instalação"*. No corpo da issue, tente seguir o seguinte formato:
  30 +Se o bug realmente não foi resolvido ou acolhido então está na hora de
  31 +[criar uma nova issue](https://github.com/portabilis/i-educar/issues/new). No
  32 +título da issue tente resumir da melhor forma o problema evitando títulos
  33 +genéricos como *"Falha no sistema"* ou *"Problemas na instalação"*. No corpo da
  34 +issue, tente seguir o seguinte formato:
24 35  
25 36 ```
26   -**MENU:** Nesta seção deve ser apontado qual o menu no sistema deve ser realizada a alteração.
  37 +**MENU:** Nesta seção deve ser apontado qual o menu no sistema deve ser
  38 +realizada a alteração.
27 39  
28   -**DESCRIÇÃO:** Nesta seção deve ser colocado uma descrição do problema ou necessidade.
  40 +**DESCRIÇÃO:** Nesta seção deve ser colocado uma descrição do problema ou
  41 +necessidade.
29 42  
30 43 **OBSERVAÇÕES:** Observações em geral sobre o problema apontado.
31 44 ```
... ... @@ -39,7 +52,9 @@ i-Educar - Escola > Cadastro > Turma > Cadastrar
39 52  
40 53 **DESCRIÇÃO:**
41 54  
42   -No cadastro de turmas, ao selecionar a opção Multi-seriada, todas as séries aparecem para seleção, quando deveria ser somente as da escola e curso selecionado.
  55 +No cadastro de turmas, ao selecionar a opção Multi-seriada, todas as séries
  56 +aparecem para seleção, quando deveria ser somente as da escola e curso
  57 +selecionado.
43 58  
44 59 **OBSERVAÇÕES:**
45 60  
... ... @@ -47,80 +62,148 @@ Não se aplica.
47 62  
48 63 ```
49 64  
50   -Se possível inclua imagens ou vídeos à descrição do bug para facilitar o processo de reprodução. Use um software como [LICEcap](https://www.cockos.com/licecap/) para criar um gif animado de sua tela. Informe também detalhes sobre o seu ambiente: plataforma de execução, sistema operacional, navegador e versão, etc. Você também deve adicionar o label **bug** à issue.
  65 +Se possível inclua imagens ou vídeos à descrição do bug para facilitar o
  66 +processo de reprodução. Use um software como
  67 +[LICEcap](https://www.cockos.com/licecap/) para criar um gif animado de sua
  68 +tela. Informe também detalhes sobre o seu ambiente: plataforma de execução,
  69 +sistema operacional, navegador e versão, etc. Você também deve adicionar o
  70 +label **bug** à issue.
51 71  
52 72 #### Nota sobre falhas de segurança
53 73  
54   -Se você encontrou alguma falha de segurança **não use as issues para reportar o bug**. Escreva o seu report diretamente para o endereço de e-mail `comunidade@portabilis.com.br`. Ele será analisado, validado e corrigido de acordo com as necessidades. Pedimos que **não torne a falha pública** para segurança de todos que utilizam a plataforma em seu estado atual.
  74 +Se você encontrou alguma falha de segurança **não use as issues para reportar o
  75 +bug**. Escreva o seu report diretamente para o endereço de e-mail
  76 +`comunidade@portabilis.com.br`. Ele será analisado, validado e corrigido de
  77 +acordo com as necessidades. Pedimos que **não torne a falha pública** para
  78 +segurança de todos que utilizam a plataforma em seu estado atual.
55 79  
56 80 ### Indicando melhorias
57 81  
58   -Outra ótima forma de contribuir é indicando melhorias ao código do i-Educar e em como ele está estruturado. Se você tem qualquer ideia de como podemos melhorar alguma abordagem na solução de problemas, refatoração de código, melhoria em algum recurso ou qualquer outra coisa relacionada, siga estes passos:
59   -
60   -1. Certifique-se de que sua ideia já não esteja sendo abordada em nosso [roadmap](./README.md#roadmap-de-tecnologia);
61   -2. Também verifique se a ideia já não está pressente em nossas [issues do GitHub](https://github.com/portabilis/i-educar/issues);
62   -3. Defenda a sua ideia e explique de forma convincente porque ela deve ser acolhida. Eis algumas questões a considerar:
  82 +Outra ótima forma de contribuir é indicando melhorias ao código do i-Educar e em
  83 +como ele está estruturado. Se você tem qualquer ideia de como podemos melhorar
  84 +alguma abordagem na solução de problemas, refatoração de código, melhoria em
  85 +algum recurso ou qualquer outra coisa relacionada, siga estes passos:
  86 +
  87 +1. Certifique-se de que sua ideia já não esteja sendo abordada em nosso
  88 + [roadmap](./README.md#roadmap-de-tecnologia);
  89 +2. Também verifique se a ideia já não está pressente em nossas
  90 + [issues do GitHub](https://github.com/portabilis/i-educar/issues);
  91 +3. Defenda a sua ideia e explique de forma convincente porque ela deve ser
  92 + acolhida. Eis algumas questões a considerar:
63 93 1. Você realmente esta propondo uma ideia só ou um conjunto de ideias?
64 94 2. Qual é o problema que sua ideia resolve?
65 95 3. Por que sua sugestão é melhor do que o que já existe no código?
66   - 4. Realmente vale a pena demandar tempo para implementar sua ideia dentro de nossas prioridades?
  96 + 4. Realmente vale a pena demandar tempo para implementar sua ideia dentro de
  97 + nossas prioridades?
67 98  
68   -Tendo passado pelo crivo de todos estes questionamentos basta [criar uma nova issue](https://github.com/portabilis/i-educar/issues/new) descrevendo as melhorias e usando o label **melhorias**.
  99 +Tendo passado pelo crivo de todos estes questionamentos basta
  100 +[criar uma nova issue](https://github.com/portabilis/i-educar/issues/new)
  101 +descrevendo as melhorias e usando o label **melhorias**.
69 102  
70 103 ### Pedindo recursos
71 104  
72   -Tendo em vista o que estamos construindo junto com a comunidade, novos recursos tem baixa prioridade no nosso fluxo. Vale a pena enviar sua sugestão de recurso apenas se:
  105 +Tendo em vista o que estamos construindo junto com a comunidade, novos recursos
  106 +tem baixa prioridade no nosso fluxo. Vale a pena enviar sua sugestão de recurso
  107 +apenas se:
73 108  
74   -1. O recurso em questão resolve um problema que não é resolvido por nada que já exista no projeto;
75   -2. O recurso resolve um problema real validado por pessoas que estão em contato direto com a utilização da plataforma: secretários, gestores, professores, alunos, etc.
  109 +1. O recurso em questão resolve um problema que não é resolvido por nada que já
  110 + exista no projeto;
  111 +2. O recurso resolve um problema real validado por pessoas que estão em contato
  112 + direto com a utilização da plataforma: secretários, gestores, professores,
  113 + alunos, etc.
76 114  
77   -Um exemplo de um bom recurso implementado para o i-Educar é o módulo do **censo escolar** que visa resolver todo o processo de exportação de dados para o censo escolar com apenas alguns cliques, otimizando de forma radical este processo que antes poderia demorar semanas envolvendo o trabalho de muitas pessoas.
  115 +Um exemplo de um bom recurso implementado para o i-Educar é o módulo do **censo
  116 +escolar** que visa resolver todo o processo de exportação de dados para o censo
  117 +escolar com apenas alguns cliques, otimizando de forma radical este processo que
  118 +antes poderia demorar semanas envolvendo o trabalho de muitas pessoas.
78 119  
79   -Para criar seu pedido de recurso basta [criar uma nova issue](https://github.com/portabilis/i-educar/issues/new) usando o label **recurso**.
  120 +Para criar seu pedido de recurso basta
  121 +[criar uma nova issue](https://github.com/portabilis/i-educar/issues/new) usando
  122 +o label **recurso**.
80 123  
81 124 ### Discutindo as issues
82 125  
83   -Antes de partirmos para o código em si é muito importante discutirmos com a comunidade como cada issue será abordada. Toda e qualquer questão deve ser colocada em discussão para que qualquer pessoa que deseje solucionar aquele problema tenha o máximo de informações para executar uma solução.
  126 +Antes de partirmos para o código em si é muito importante discutirmos com a
  127 +comunidade como cada issue será abordada. Toda e qualquer questão deve ser
  128 +colocada em discussão para que qualquer pessoa que deseje solucionar aquele
  129 +problema tenha o máximo de informações para executar uma solução.
84 130  
85   -Idealmente todas as issues devem ter um plano de ação claro antes que qualquer código seja escrito. Sabemos que muitas vezes isto não é possível, sendo necessário explorar e analisar melhor o que foi indicado. Nestes casos, publique todas as suas descobertas nas discussões indicando caminhos e recebendo o feedback da comunidade a respeito do que está sendo proposto.
  131 +Idealmente todas as issues devem ter um plano de ação claro antes que qualquer
  132 +código seja escrito. Sabemos que muitas vezes isto não é possível, sendo
  133 +necessário explorar e analisar melhor o que foi indicado. Nestes casos, publique
  134 +todas as suas descobertas nas discussões indicando caminhos e recebendo o
  135 +feedback da comunidade a respeito do que está sendo proposto.
86 136  
87   -Issues que estão em processo de discussão devem receber o label **discussão** indicando que aquela issue precisa dos inputs e feedbacks dos membros da comunidade. Nós te encorajamos a participar o máximo possível mas fique atento ao nosso [código de conduta](./CODE_OF_CONDUCT.md) antes de realizar qualquer interação com os outros membros da comunidade.
  137 +Issues que estão em processo de discussão devem receber o label **discussão**
  138 +indicando que aquela issue precisa dos inputs e feedbacks dos membros da
  139 +comunidade. Nós te encorajamos a participar o máximo possível mas fique atento
  140 +ao nosso [código de conduta](./CODE_OF_CONDUCT.md) antes de realizar qualquer
  141 +interação com os outros membros da comunidade.
88 142  
89 143 ### Fazendo pull requests
90 144  
91   -Depois de ter um plano de ação relativamente claro você deve estar pronto para contribuir com código. Para isso faça um fork do i-Educar e trabalhe em cima de um branch diferente de master implementando suas soluções. Para saber mais sobre pull requests e como eles funcionam, veja [este link](https://help.github.com/articles/about-pull-requests/).
  145 +Depois de ter um plano de ação relativamente claro você deve estar pronto para
  146 +contribuir com código. Para isso faça um fork do i-Educar e trabalhe em cima de
  147 +um branch diferente de master implementando suas soluções. Para saber mais sobre
  148 +pull requests e como eles funcionam, veja
  149 +[este link](https://help.github.com/articles/about-pull-requests/).
92 150  
93 151 Antes de abrir seu PR (pull request) certique-se que:
94 152  
95   -- O código realmente resolve um problema real (de preferência baseado em alguma issue levantada);
96   -- Seu PR resolve uma issue apenas. Se você quiser fazer mais de uma coisa, divida em vários PRs;
97   -- Seu código é funcional (ou algo próximo disso). Providencie testes se possível;
  153 +- O código realmente resolve um problema real (de preferência baseado em alguma
  154 + issue levantada);
  155 +- Seu PR resolve uma issue apenas. Se você quiser fazer mais de uma coisa,
  156 + divida em vários PRs;
  157 +- Seu código é funcional (ou algo próximo disso). Providencie testes se
  158 + possível;
98 159 - Seu código adere às convenções do [PSR-2](https://www.php-fig.org/psr/psr-2/);
99   -- Seus commits englobam bem as funcionalidades desenvolvidas. Evite espalhar o desenvolvimento de um recurso em múltiplos commits;
100   -- Se for inevitável criar vários commits intermediários, por favor execute um [squash](https://git-scm.com/book/pt-br/v1/Ferramentas-do-Git-Reescrevendo-o-Hist%C3%B3rico#Achatando-um-Commit) antes de abrir seu PR;
101   -- As mensagens de seus commits são claras e descrevem bem o trabalho. Para maiores dicas sobre como escrever mensagens de commit adequadas, veja [este guia](https://chris.beams.io/posts/git-commit/).
102   -
103   -Caso seu PR não atenda a uma destas demandas ele poderá ser fechado. Isto inclui PRs que tentam resolver problemas reais mas que contém código cheio de erros ou soluções incompletas. Para que a nossa lista de PRs não fique poluída, dificultando o trabalho de outros membros da comunidade que podem ajudar revisando as mudanças, pedimos que PRs sejam abertos quando sua solução estiver a mais completa possível. Por isso é imprescindível usar a discussão nas issues para a criação de soluções mais acertivas.
  160 +- Seus commits englobam bem as funcionalidades desenvolvidas. Evite espalhar o
  161 + desenvolvimento de um recurso em múltiplos commits;
  162 +- Se for inevitável criar vários commits intermediários, por favor execute um
  163 + [squash](https://git-scm.com/book/pt-br/v1/Ferramentas-do-Git-Reescrevendo-o-Hist%C3%B3rico#Achatando-um-Commit)
  164 + antes de abrir seu PR;
  165 +- As mensagens de seus commits são claras e descrevem bem o trabalho. Para
  166 + maiores dicas sobre como escrever mensagens de commit adequadas, veja
  167 + [este guia](https://chris.beams.io/posts/git-commit/).
  168 +
  169 +Caso seu PR não atenda a uma destas demandas ele poderá ser fechado. Isto inclui
  170 +PRs que tentam resolver problemas reais mas que contém código cheio de erros ou
  171 +soluções incompletas. Para que a nossa lista de PRs não fique poluída,
  172 +dificultando o trabalho de outros membros da comunidade que podem ajudar
  173 +revisando as mudanças, pedimos que PRs sejam abertos quando sua solução estiver
  174 +a mais completa possível. Por isso é imprescindível usar a discussão nas issues
  175 +para a criação de soluções mais acertivas.
104 176  
105 177 #### Sobre mudanças cosméticas
106 178  
107   -PRs que realizam apenas mudanças cosméticas como remoção de espaços em branco, ajustes de indentação, etc., não serão aceitos. Nós valorizamos um código bem escrito e queremos padronizar nossas práticas, mas PRs que não entregarem nenhuma melhoria na estabilidade, funcionalidade, testabilidade do projeto ou compatibilidade com os padrões sendo adotados (PSR-2) serão fechados. Para entender melhor sobre esta decisão veja [esta discussão](https://github.com/rails/rails/pull/13771#issuecomment-32746700).
  179 +PRs que realizam apenas mudanças cosméticas como remoção de espaços em branco,
  180 +ajustes de indentação, etc., não serão aceitos. Nós valorizamos um código bem
  181 +escrito e queremos padronizar nossas práticas, mas PRs que não entregarem
  182 +nenhuma melhoria na estabilidade, funcionalidade, testabilidade do projeto ou
  183 +compatibilidade com os padrões sendo adotados (PSR-2) serão fechados. Para
  184 +entender melhor sobre esta decisão veja
  185 +[esta discussão](https://github.com/rails/rails/pull/13771#issuecomment-32746700).
108 186  
109 187 ### Outras formas de contribuir
110 188  
111   -Se você não trabalha com código mas quer ajudar o i-Educar, existe muitas outras formas de contribuir:
  189 +Se você não trabalha com código mas quer ajudar o i-Educar, existe muitas outras
  190 +formas de contribuir:
112 191  
113 192 - Ajude com a documentação do projeto (mais informações em breve);
114 193 - Fale sobre o i-Educar nas suas redes sociais, blogs, etc. Espalhe a palavra;
115 194 - Organize eventos e dê palestras sobre o i-Educar;
116   -- Crie material promocional como apresentações, screencasts, mídia para compartilhamento em redes sociais, etc;
117   -- Viu alguma discussão que te interessa e onde você pode acrescentar mesmo sem conhecimento técnico? Não se acanhe e participe também nas issues do GitHub.
  195 +- Crie material promocional como apresentações, screencasts, mídia para
  196 + compartilhamento em redes sociais, etc;
  197 +- Viu alguma discussão que te interessa e onde você pode acrescentar mesmo sem
  198 + conhecimento técnico? Não se acanhe e participe também nas issues do GitHub.
118 199  
119   -Pensou em alguma outra forma de contribuir? Compartilha com a gente! Escreva para `comunidade@portabilis.com.br` e conte sua história.
  200 +Pensou em alguma outra forma de contribuir? Compartilha com a gente! Escreva
  201 +para `comunidade@portabilis.com.br` e conte sua história.
120 202  
121 203 # Créditos
122 204  
123   -Este documento foi escrito com o auxílio de outros documentos similares utilizados em outras comunidades. Destacamos:
  205 +Este documento foi escrito com o auxílio de outros documentos similares
  206 +utilizados em outras comunidades. Destacamos:
124 207  
125 208 - [Metabase](https://github.com/metabase/metabase/blob/master/docs/contributing.md)
126 209 - [Ghost](https://docs.ghost.org/v1/docs/contributing)
... ...