Contributing #211

farribeiro · 2018-06-07T23:55:24Z

Contribuiting e outras coisinhas

Closes #201

farribeiro

Para revisão

williamespindola · 2018-06-08T02:18:12Z

CONTRIBUTING.md

+
+- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
+
+- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.


A intenção é adicionar a este tópico o que coloquei na issue #199 de Release Cycle. Mas precisamos definir la primeiro. O que coloquei la segue o SemVer v2.0.0

williamespindola · 2018-06-08T02:19:46Z

composer.json

  "config": {
    "vendor-dir": "ieducar/vendor"
  },
  "require": {
+    "php": "~7.0",


Um dos motivos que ainda não tinha feito o PR era porque eu ainda não sabia qual era a versão do PHP que o projeto esta rodando, você sabe @farribeiro?

williamespindola · 2018-06-08T02:21:28Z

composer.json

+    "psr-4": {
+      "Portabilis\\Ieducar\\": "tests"
+    }
+  },


O projeto não esta usando namespace, então não tem problema ficar estes caminhos nos autoloaders. Logo que começar a migrar para namespace vai começar a encostar nisto.

farribeiro · 2018-06-08T03:40:58Z

Se não me engano tem um problema no seu commit ... Nele você altera um JSON

williamespindola · 2018-06-08T03:47:52Z

O composer.json?

farribeiro · 2018-06-08T11:34:25Z

Yep

Faça alterações necessárias para que este PR seja aceito

williamespindola · 2018-06-09T03:20:00Z

Done, composer atualizado e ja aproveitei para configurar o code sniffer junto do scrutinizer, ja podemos ter algumas métricas do que não esta seguindo o contributing.

farribeiro · 2018-06-09T05:13:07Z

Pode ser mergeado assim mesmo?

MarceloCajueiro · 2018-06-09T14:23:47Z

Galera. Sei que ainda não temos regras e boas práticas definidas, mas esse PR tem muita coisa aberta.

Alguns pontos:

@farribeiro acho complicado você abrir pull request de algo que não é você que está trabalhando.
Uma boa prática é ter pequenos commits separando o que cada um faz
Uma outra boa prática é abrir PR de assuntos específicos. Ex.: Adiciona code sniffer, Configura scrutinizer, Adiciona doc de contribuição.

O doc de contribuição o @eberfreitas está trabalhando duro nele. Depois podemos adequar com o que foi feito aqui.

Outra coisa é que nosso público alvo é o Brasil e muitos profissionais de TI que forem olhar o projeto podem ter dificuldade no Inglês, então o ideal é documentação escrita em Português.

Sugiro fechar esse PR e reabrir com assuntos específicos.

farribeiro · 2018-06-09T14:25:37Z

Então será fechado e propõe a mesma PR do branch, que tive a iniciativa de propor o trabalho alheio.

Lembre-se disso #201 (comment)

farribeiro · 2018-06-09T19:31:46Z

@MarceloCajueiro levar em consideração que o mantedor do branch, @williamespindola , considera Ok para merge!

@williamespindola dê o tique verde aí

MarceloCajueiro · 2018-06-09T21:49:15Z

.scrutinizer.yml

@@ -0,0 +1,19 @@
+filter:
+    excluded_paths:
+        - tests/*


acho que devemos adicionar aqui:

- 'ieducar/tests/*' - 'ieducar/misc/**/*'

MarceloCajueiro · 2018-06-09T21:51:21Z

composer.json

+    "fabpot/php-cs-fixer": "Fix PSR2 and other coding style issues"
+  },
+  "autoload": {
+    "psr-4": {


adicionar isso não quebra nada o projeto?

Não deveria porque hoje vocês não estou usando o autoload, estão fazendo require_once de todas as dependências. Vou dar uma olhada mais afundo.

MarceloCajueiro · 2018-06-09T21:51:39Z

composer.json

@@ -1,15 +1,48 @@
 {


as mudanças no composer, nada aqui pode impactar o código de produção?

MarceloCajueiro · 2018-06-09T21:52:30Z

CONTRIBUTING.md

+```
+
+
+**Happy coding**!


acho que esse arquivo pode ser removido. Vamos achar a melhor versão para isso na issue.

Seria legal esse PR cobrir apenas ferramentas que garantem o mínimo de qualidade, sem quebrar o projeto.

MarceloCajueiro · 2018-06-09T21:55:09Z

.scrutinizer.yml

@@ -0,0 +1,19 @@
+filter:
+    excluded_paths:
+        - tests/*


Acho que não adianta colocar os testes para rodar se o atual não funciona. Colocar test: false seria bom.

Não seria legal manter para ver o quando progredimos na aplicação dos testes?

Até podemos, mas até a primeira implementação de teste sair vai ficar red.

farribeiro · 2018-06-09T22:06:49Z

Aplique ASAP para não termos maiores problemas com o scrutinizer

- Arquivo com guia e regras para contribuição - Refatora arquivo composer.json com novas dependências e configurações - Adiciona como dependência fabpot/php-cs-fixer para chegar o estilo do código

williamespindola

@farribeiro bora separar este Pr em partes diferentes? O de contributing vamos deixar para o #219 eu ja levantei o que enviamos neste relacionado a contributing que esta faltando la. E o de la ficou melhor que o meu, o meu ficou muito técnico.

Acho que podemos separar em 2:

Adiciona code sniffer, adicionando o arquivo de configuração .php_cs e o composer.json
Configura scrutinizer, apenas o arquivo .scrutinizer.yml

Vamos apenas definir as questões que o @MarceloCajueiro levantou ali e enviar os PRs.

farribeiro commented Jun 7, 2018

View reviewed changes

williamespindola approved these changes Jun 8, 2018

View reviewed changes

farribeiro closed this Jun 9, 2018

farribeiro reopened this Jun 9, 2018

MarceloCajueiro requested changes Jun 9, 2018

View reviewed changes

MarceloCajueiro reviewed Jun 9, 2018

View reviewed changes

Aplica guia e regras para contribuição

5f4bb61

- Arquivo com guia e regras para contribuição - Refatora arquivo composer.json com novas dependências e configurações - Adiciona como dependência fabpot/php-cs-fixer para chegar o estilo do código

eberfreitas mentioned this pull request Jun 10, 2018

Guia de contribuição #219

Merged

williamespindola suggested changes Jun 11, 2018

View reviewed changes

farribeiro closed this Jun 11, 2018

farribeiro self-assigned this Jun 11, 2018

This was referenced Jun 12, 2018

Adicionar arquivo de configuração do scrutinizer #233

Closed

Configurar code sniffer #234

Closed

eberfreitas mentioned this pull request Jun 18, 2018

API para quadro horario #252

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Contributing #211

Contributing #211

farribeiro commented Jun 7, 2018 •

edited

Loading

farribeiro left a comment

williamespindola Jun 8, 2018

williamespindola Jun 8, 2018

williamespindola Jun 8, 2018

farribeiro commented Jun 8, 2018 •

edited

Loading

williamespindola commented Jun 8, 2018

farribeiro commented Jun 8, 2018 •

edited

Loading

williamespindola commented Jun 9, 2018

farribeiro commented Jun 9, 2018

MarceloCajueiro commented Jun 9, 2018

farribeiro commented Jun 9, 2018 •

edited

Loading

farribeiro commented Jun 9, 2018 •

edited

Loading

MarceloCajueiro Jun 9, 2018

MarceloCajueiro Jun 9, 2018

williamespindola Jun 11, 2018

MarceloCajueiro Jun 9, 2018

MarceloCajueiro Jun 9, 2018

MarceloCajueiro Jun 9, 2018

williamespindola Jun 11, 2018

MarceloCajueiro Jun 11, 2018

farribeiro commented Jun 9, 2018

williamespindola left a comment


		- Document any change in behaviour - Make sure the `README.md` and any other relevant documentation are kept up-to-date.

		- Consider our release cycle - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.

		```


		Happy coding!

Contributing #211

Contributing #211

Conversation

farribeiro commented Jun 7, 2018 • edited Loading

farribeiro left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

farribeiro commented Jun 8, 2018 • edited Loading

williamespindola commented Jun 8, 2018

farribeiro commented Jun 8, 2018 • edited Loading

williamespindola commented Jun 9, 2018

farribeiro commented Jun 9, 2018

MarceloCajueiro commented Jun 9, 2018

farribeiro commented Jun 9, 2018 • edited Loading

farribeiro commented Jun 9, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

farribeiro commented Jun 9, 2018

williamespindola left a comment

Choose a reason for hiding this comment

farribeiro commented Jun 7, 2018 •

edited

Loading

farribeiro commented Jun 8, 2018 •

edited

Loading

farribeiro commented Jun 8, 2018 •

edited

Loading

farribeiro commented Jun 9, 2018 •

edited

Loading

farribeiro commented Jun 9, 2018 •

edited

Loading