okfn-brasil / serenata-toolbox

📦 pip module containing code shared across Serenata de Amor's projects | ** Este repositório não recebe atualizações frequentes **
MIT License
154 stars 69 forks source link

Issue Template #136

Closed jtemporal closed 7 years ago

jtemporal commented 7 years ago

Hi as many know, it can be scary to give your first contribution to open source. And sometimes you may need help to start contributing to a new project.

Thinking of that and reading First Timers Only website for hints we thought would be nice to do two things:

  1. Create the first-timers-only label: Done
  2. Create a template to help people opening up a new issue.

So here is the first draft of a issue_template to be added to this and all of the other Serenata's repositories.

This issue will be open to collect ideas on how to make this template as friendly as possible but also generic so everyone can feel comfortable using it. Any feedback is much appreciated 😉

Special thanks to @lipemorais who helped in coming up with this ❤️

anaschwendler commented 7 years ago

@jtemporal Maybe in the first line you can use:

Issue Template -> Here add the name of the Issue/ Pull Request

"This template is here to help you to write your issue ;)" -> introduce here the problem

And it is OK to me ;)

rodolfo-viana commented 7 years ago

As a newbie, I just want to say it warms my heart to see this going on.

renatooliveira commented 7 years ago

Here at @labcodes we use checklists for everything. We don't have an issue template but here is our pull request template

https://gist.github.com/renatooliveira/09418592b8891f663f3060f2f61e891f

cuducos commented 7 years ago

At first I must say the only in first timers only bugged me — specially in these two hypothetical scenarios:

Both situations might be harmful for the project: the first one delays progress, the second one might discourage someone that has dedicated time to the project.

However when I shared this thoughts with @jtemporal she responded with:

It's a worldwide standard, I like it it is an worldwide standard — and Special cases aren't special enough to break the rules.

And I followed:

And practicality beats purity.

And that is the story when I got convinced this is in fact a really good idea — only included.

disouzaleo commented 7 years ago

I just loved !

cuducos commented 7 years ago

Closed by #137

gr2m commented 6 years ago

Hey I just found out about this by chance :) I think you’d enjoy https://github.com/apps/first-timers let me know if you have any questions