quero-edu / guidelines

📘 The definitive Quero Education code-style guide.
MIT License
22 stars 2 forks source link

Precisa criar templates de issue e PR #8

Closed vhoyer closed 3 years ago

vhoyer commented 4 years ago

@danilovaz, tem alguma sugestão de como a gente podia fazer os templates?

danilovaz commented 4 years ago

@vhoyer fechando minhas tasks de hj, tento bolar algo com calma aqui e a gente chega em um modelo <3

vhoyer commented 4 years ago

deixa eu te dar uma base pra você não ter que pensar tudo sozinho :sweat_smile: (lembrando que esse repo é publico e a gente não ta muito acostumado com isso :D)

PR:

### Proposta
<!-- o que é a modificação desse PR -->
### Motivação
<!-- qual o problema a ser resolvido por ele -->

Issue:

### Porque isso é um problema?
<!--  -->

por favor, sinta-se mais que a vontade para mudar o que quiser na minha sugestão :D

iurynogueira commented 3 years ago

O que acham disso para as PRs?

======

[ ] Bugfix 🐛

[ ] Feature ✨

[ ] Refactor 🔨

[ ] Build-Mudança relatada 🔖

[ ] Outro, por favor descrever:

[ ] Unitário

[ ] Integração/Headless

[ ] Nenhum, porque:

vhoyer commented 3 years ago

ta, faz muito tempo que essa issue ta abandonada aqui, vamo tentar fechar ela então, aproveitando que cê reviveu ela (vlw pela contribuição), então assim, eu curto deixar separado o "what" e o "why", qq cê acha?

* O que esta PR faz?

* Porque nós precisamos fazer isso?

* Que tipo de mudança foi introduzida?

- [ ] Bugfix 🐛 
- [ ] Feature ✨ 
- [ ] Refactor 🔨 
- [ ] Build-Mudança relatada 🔖 
- [ ] Outro, por favor descrever:

* Que tipo de teste foi implementado? ✅ 

- [ ] Unitário
- [ ] Integração/Headless
- [ ] Nenhum, porque:

* Observações para o revisor:

E assim eu pessoalmente acho que qqr coisa que é valida colocar no Observações para o revisor deveriam estar no próprio repo como documentação/markdown, comentários no código, ou mensagens de commit, e portanto, essa seção fica um pouco redundante, mas também não vejo muito valor em tirar ela, então acho ok a gente continuar com ela no template, qq cê, @iurynogueira, acha dessas mudanças que eu tô propondo?

iurynogueira commented 3 years ago

ta, faz muito tempo que essa issue ta abandonada aqui, vamo tentar fechar ela então, aproveitando que cê reviveu ela (vlw pela contribuição), então assim, eu curto deixar separado o "what" e o "why", qq cê acha?

* O que esta PR faz?

* Porque nós precisamos fazer isso?

* Que tipo de mudança foi introduzida?

- [ ] Bugfix 🐛 
- [ ] Feature ✨ 
- [ ] Refactor 🔨 
- [ ] Build-Mudança relatada 🔖 
- [ ] Outro, por favor descrever:

* Que tipo de teste foi implementado? ✅ 

- [ ] Unitário
- [ ] Integração/Headless
- [ ] Nenhum, porque:

* Observações para o revisor:

E assim eu pessoalmente acho que qqr coisa que é valida colocar no Observações para o revisor deveriam estar no próprio repo como documentação/markdown, comentários no código, ou mensagens de commit, e portanto, essa seção fica um pouco redundante, mas também não vejo muito valor em tirar ela, então acho ok a gente continuar com ela no template, qq cê, @iurynogueira, acha dessas mudanças que eu tô propondo?

Acho que se já tem doc/md para ajudar o revisor ficaria realmente redundante mesmo, podemos remover e colocar uma OBS dizendo que qualquer dúvida consultar a documentação. Podemos abrir PR?

vhoyer commented 3 years ago

Acho que sim :D, cê quer fazer isso pra nós?

iurynogueira commented 3 years ago

Acho que sim :D, cê quer fazer isso pra nós?

Quero demais!