Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add issue template #6604

Merged
merged 2 commits into from
Jun 15, 2019
Merged

Add issue template #6604

merged 2 commits into from
Jun 15, 2019

Conversation

liufengyun
Copy link
Contributor

We use single template instead of multiple templates for better usability,
as most of the time people create issues, make them to choose between templates is annoying.

Meanwhile, we minimize information load by avoiding too much info in the template.

The difference between multiple templates and single template can be seen below:

We use single template instead of multiple templates for better usability,
as most of the time people create issues, make them to choose between templates is annoying.

Meanwhile, we minimize information load by avoiding too much info in the template.

The difference between multiple templates and single template can be seen below:

- https://help.github.com/en/articles/manually-creating-a-single-issue-template-for-your-repository
@nicolasstucki
Copy link
Contributor

Shouldn't we have multiple templates as in https://github.com/akka/akka/issues/new/choose? This way we write shorter an and more targeted templates for each situation.

@liufengyun
Copy link
Contributor Author

We may switch to multiple templates when the need appears. Currently it seems annoying to see the choices page, as most of the time we just create issues, and feature requests are not really a template.

Copy link
Member

@dwijnand dwijnand left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Your mileage may vary, but I've found it very useful to have users be explicit in distinctly identifying the problem (in their eyes) and their expectations. Therefore I recommend having sections along the lines of:

docs/issue_template.md Outdated Show resolved Hide resolved
@SethTisue
Copy link
Member

We may switch to multiple templates when the need appears

indeed, your feelings may eventually change as your userbase increases and their average experience level decreases :-)

@liufengyun
Copy link
Contributor Author

Thanks @dwijnand @SethTisue @nicolasstucki : just did a small opinion poll during lunch, people tend like multiple templates. Let's try the multiple templates first, we can always downgrade to single template when necessary.

Copy link
Member

@dwijnand dwijnand left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@nicolasstucki nicolasstucki merged commit eb27b4a into scala:master Jun 15, 2019
@nicolasstucki nicolasstucki deleted the issue-template branch June 15, 2019 07:54
@anatoliykmetyuk anatoliykmetyuk added this to the 0.17 Tech Preview milestone Jul 22, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants