search

DarkmiraTour / community-event-manager

Web application with a collection of tools helping people organising community events such as multi-days conference with reminders, CRM and such
GNU General Public License v3.0
21 stars 21 forks source link

add pull request template #94

Closed kevinjhappy closed 5 years ago

kevinjhappy commented 5 years ago

Adds a Github issue template to help contributors and users write more detailed issues.

No related issues as it seems to be a short and easy story to handle.

tdutrion commented 5 years ago

Description of the PR is missing as well as a related issue that would be fixed with this PR @kevinjhappy.

tdutrion commented 5 years ago

My own take would be that issues and feature requests should be separated in different templates, as described in Github's doc.

Try to be more specific, for instance in a bug report, questions on the host system and installation method (reproduction steps in fact). For feature requests, a DDD approach would be nice, having a template that reads as Gherkin

kevinjhappy commented 5 years ago

@tdutrion Thanks for your feedback, when I got your messages I was looking to create issues_template, but I might misunderstand, you asked to change the pull request template into 2 part, one for bug and the other for the feature or creating issue template is the right way to do it?

About Gherkin, I need to inspire this methodology to prepare a sentence into the template?

tdutrion commented 5 years ago

@tdutrion Thanks for your feedback, when I got your messages I was looking to create issues_template, but I might misunderstand, you asked to change the pull request template into 2 part, one for bug and the other for the feature or creating issue template is the right way to do it?

That would be great indeed to have multiple issues templates. Basically, rather than creating ISSUE_TEMPLATE.md you can do a ISSUE_TEMPLATE folder with issues template in it. The Pull request template is still a single one, still the same file

About Gherkin, I need to inspire this methodology to prepare a sentence into the template?

Indeed, just leading the user to give more precise details.