Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Guia de contribuição #219

Merged
merged 4 commits into from
Jun 11, 2018
Merged

Guia de contribuição #219

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
28e870d
Versão inicial do CONTRIBUTING.md;
eberfreitas Jun 10, 2018
bef1603
Adicionando templates para issues;
eberfreitas Jun 10, 2018
6fb6f45
Ajustes discutidos no PR #219;
eberfreitas Jun 11, 2018
204f749
Typos e ajustes;
eberfreitas Jun 11, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .github/ISSUE_TEMPLATE/bugs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,10 @@ Nesta seção deve ser colocado uma descrição do problema ou necessidade.
**OBSERVAÇÕES:**

Observações em geral sobre o problema apontado.

**AMBIENTE:**

- Plataforma utilizada (p.ex. Docker, instalação direta):
- Sistema operacional e versão (p.ex. Ubuntu 16.04, Windows 7):
- Navegador e versão (p.ex. Chrome 35.9.9.9):
- Outros detalhes importantes:
12 changes: 11 additions & 1 deletion .github/ISSUE_TEMPLATE/outros.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,14 @@ about: Para indicar melhorias ou recursos use este template!
Olá e obrigado por nos ajudar a tornar o i-Educar um projeto melhor. Não esqueça
de revisar o nosso
[guia de contribuição](https://github.com/portabilis/i-educar/blob/master/CONTRIBUTING.md)
para saber melhor como colaborar com a nossa comunidade.
para saber melhor como colaborar com a nossa comunidade. Você também pode usar
o template abaixo para preencher sua issue:

**CONTEXTO:**

Porque esta alteração é importante? Como você usaria isto? Como esta alteração
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Por que" para pergunta é separado :P

pode beneficiar outros usuários?

**IMPLEMENTAÇÃO:**

Não obrigatório, mas sugira uma idéia de como isto poderia ser implementado.
11 changes: 6 additions & 5 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Não se aplica.

```
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Colocando o template dentro de .github/ISSUE_TEMPLATE ele automagicamente vai aparecer dentro do formulário qual alguém for criar uma issue, precisamos deixar aqui também?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Não entendi mto bem a pergunta, mas esse esquema funciona +/- assim:

https://github.com/TryGhost/Ghost/issues/new/choose

Eu nunca usei realmente e espero q tenha feito certo :P

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Animal isso!


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.
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.

#### Nota sobre falhas de segurança

Expand Down Expand Up @@ -93,17 +93,18 @@ Depois de ter um plano de ação relativamente claro você deve estar pronto par
Antes de abrir seu PR (pull request) certique-se que:

- O código realmente resolve um problema real (de preferência baseado em alguma issue levantada);
- Seu código está completo ou próximo de estar completo;
- Sua solução realmente funciona. Providencie testes se possível;
- Seu PR resolve uma issue apenas. Se você quiser fazer mais de uma coisa, divida em vários PRs;
- Seu código é funcional (ou algo próximo disso). Providencie testes se possível;
- Seu código adere às convenções do [PSR-2](https://www.php-fig.org/psr/psr-2/);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Devemos aplicar o PHP-FIG como um todo e não apenas a PSR-2

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Acho que antes de obrigar tudo, o projeto deve ter tudo.

Etapa um seria o PSR1 e 2, então já temos que pedir isso aqui. Quando evoluirmos mais, vamos aumentando o grau de exigência. O que acha?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Vejo o FIG como um standard para todo o projeto, é certo que vamos aplicar gradualmente, mas é bom aplicar de forma global.

- Seus commits englobam bem as funcionalidades desenvolvidas. Evite WIPs;
- Seus commits englobam bem as funcionalidades desenvolvidas. Evite espalhar o desenvolvimento de um recurso em múltiplos commits;
- 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;
- 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/).

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.

#### Sobre mudanças cosméticas

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).
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).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Então, mas se eu fizer um PR agora para aplicar a PSR 2 eu vou estar ajustando a indentação, então ele não será aceito?

Acho que esta muito genérico, e vale exemplificar. Fiz um comentário sobre este tipo de PR na issue 208

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Acho válido se está está no planejamento. Então PSR 2 pode ser aceito sim.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lembrar que PSR-2 é bem mais do que ajustar espaçamentos e tirar espaço em branco...

### Outras formas de contribuir

Expand Down
7 changes: 7 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,13 @@ melhorar a manutenibilidade e enfim permitir a evolução através de features.
- Adoção do [PSR4](https://www.php-fig.org/psr/psr-4/)
- Iniciar a cobertura de testes para possibilitar refatorações

### Planejamento Técnico

Em nossa wiki você encontra um planejamento mais técnico de como devemos
prosseguir com as melhorias e evoluções do nosso projeto.
[Clique aqui](https://github.com/portabilis/i-educar/wiki/Planejamento-T%C3%A9cnico)
para ler mais a respeito.

## Como contribuir

Contribuições são **super bem vindas**! Se você tem vontade de construir o
Expand Down