armada icon indicating copy to clipboard operation
armada copied to clipboard

Add an issue and PR template

Open stackedsax opened this issue 3 years ago • 5 comments

I think it would be useful for us to add an issue and PR template to this repo, especially if we want to encourage potential community members to contribute.

@mfkl, I know you have opinions here if you want to opine and give some suggestions. I think you've helped set up some templates in some of our other repo's. Likewise, @pavlovic-ivan. @jayofdoom, you have any guidelines you like to follow here?

stackedsax avatar Jul 11 '22 18:07 stackedsax

Hi Alex, thanks for reaching out. I would suggest using Github forms for this purpose. They give us the ability to create actual input fields with validation. Thus we can force a user to input data we can't go without

pavlovic-ivan avatar Jul 11 '22 18:07 pavlovic-ivan

Yep, I think we have a few examples from other projects that we could just apply here, yes?

stackedsax avatar Jul 11 '22 18:07 stackedsax

Correct :)

pavlovic-ivan avatar Jul 12 '22 07:07 pavlovic-ivan

I know you have opinions here if you want to opine and give some suggestions.

Yes. Most important in my experience is to require a git-hosted mcve repro from the user. This saves a lot of time and headache in the long run for maintainers, by being able to just clone and run a minimal reproducible example.

For other issue template examples, I think the consul project has a good one https://github.com/G-Research/consuldotnet/blob/master/.github/ISSUE_TEMPLATE/bug_report_form.yaml.

mfkl avatar Jul 12 '22 10:07 mfkl

Hey team! Please add your planning poker estimate with ZenHub @dejanzele @jayofdoom @kannon92 @richscott

dave-gantenbein avatar Jul 22 '22 14:07 dave-gantenbein