Commit 6fb6f45f16b3a393df927f4aed2b30d671281e1f

Authored by Éber Freitas Dias
1 parent bef16035
Exists in master

Ajustes discutidos no PR #219;

Refs portabilis/i-educar#201

- Melhora e completa os templates para issues;
- Adiciona esclarecimentos em alguns termnos no CONTRIBUTING.md;
- Completa o CONTRIBUTING.md com mais detalhes técnicos;
- Acrescenta planejamento de longo prazo (roadmap) ao README.md;
.github/ISSUE_TEMPLATE/bugs.md
... ... @@ -17,3 +17,10 @@ Nesta seção deve ser colocado uma descrição do problema ou necessidade.
17 17 **OBSERVAÇÕES:**
18 18  
19 19 Observações em geral sobre o problema apontado.
  20 +
  21 +**AMBIENTE:**
  22 +
  23 +- Plataforma utilizada (p.ex. Docker, instalação direta):
  24 +- Sistema operacional e versão (p.ex. Ubuntu 16.04, Windows 7):
  25 +- Navegador e versão (p.ex. Chrome 35.9.9.9):
  26 +- Outros detalhes importantes:
... ...
.github/ISSUE_TEMPLATE/outros.md
... ... @@ -6,4 +6,14 @@ about: Para indicar melhorias ou recursos use este template!
6 6 Olá e obrigado por nos ajudar a tornar o i-Educar um projeto melhor. Não esqueça
7 7 de revisar o nosso
8 8 [guia de contribuição](https://github.com/portabilis/i-educar/blob/master/CONTRIBUTING.md)
9   -para saber melhor como colaborar com a nossa comunidade.
  9 +para saber melhor como colaborar com a nossa comunidade. Você também pode usar
  10 +o template abaixo para preencher sua issue:
  11 +
  12 +**CONTEXTO:**
  13 +
  14 +Porque esta alteração é importante? Como você usaria isto? Como esta alteração
  15 +pode beneficiar outros usuários?
  16 +
  17 +**IMPLEMENTAÇÃO:**
  18 +
  19 +Não obrigatório, mas sugira uma idéia de como isto poderia ser implementado.
... ...
CONTRIBUTING.md
... ... @@ -47,7 +47,7 @@ Não se aplica.
47 47  
48 48 ```
49 49  
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. Você também deve adicionar o label **bug** à issue.
  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.
51 51  
52 52 #### Nota sobre falhas de segurança
53 53  
... ... @@ -93,17 +93,18 @@ Depois de ter um plano de ação relativamente claro você deve estar pronto par
93 93 Antes de abrir seu PR (pull request) certique-se que:
94 94  
95 95 - O código realmente resolve um problema real (de preferência baseado em alguma issue levantada);
96   -- Seu código está completo ou próximo de estar completo;
97   -- Sua solução realmente funciona. Providencie testes se possível;
  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;
98 98 - 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 WIPs;
  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;
100 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/).
101 102  
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.
103 104  
104 105 #### Sobre mudanças cosméticas
105 106  
106   -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 ou testabilidade do projeto serão fechados. Para entender melhor sobre esta decisão veja [esta discussão](https://github.com/rails/rails/pull/13771#issuecomment-32746700).
  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).
107 108  
108 109 ### Outras formas de contribuir
109 110  
... ...
README.md
... ... @@ -39,6 +39,13 @@ melhorar a manutenibilidade e enfim permitir a evolução através de features.
39 39 - Adoção do [PSR4](https://www.php-fig.org/psr/psr-4/)
40 40 - Iniciar a cobertura de testes para possibilitar refatorações
41 41  
  42 +### Planejamento Técnico
  43 +
  44 +Em nossa wiki você encontra um planejamento mais técnico de como devemos
  45 +prosseguir com as melhorias e evoluções do nosso projeto.
  46 +[Clique aqui](https://github.com/portabilis/i-educar/wiki/Planejamento-T%C3%A9cnico)
  47 +para ler mais a respeito.
  48 +
42 49 ## Como contribuir
43 50  
44 51 Contribuições são **super bem vindas**! Se você tem vontade de construir o
... ...