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

New Issues Template #979

Closed
virkt25 opened this issue Feb 8, 2018 · 6 comments · Fixed by #1065
Closed

New Issues Template #979

virkt25 opened this issue Feb 8, 2018 · 6 comments · Fixed by #1065
Assignees
Labels
developer-experience Issues affecting ease of use and overall experience of LB users

Comments

@virkt25
Copy link
Contributor

virkt25 commented Feb 8, 2018

I think the current issues template is super complicated and cluttered, making it harder to create an issue. See below for the original template.

<!--
Questions:
  https://groups.google.com/forum/#!forum/loopbackjs
  https://gitter.im/strongloop/loopback
Immediate support:
  https://strongloop.com/api-connect-faqs/
  https://strongloop.com/node-js/subscription-plans/
-->

# Description/Steps to reproduce

<!--
If feature: A description of the feature
If bug: Steps to reproduce
-->

# Link to reproduction sandbox

<!--
Link to an app sandbox for reproduction

Note: Failure to provide a sandbox application for reproduction purposes will result in the issue being closed.
-->

# Expected result

<!--
Also include actual results if bug
-->

# Additional information

<!--
Copy+paste the output of these two commands:
  node -e 'console.log(process.platform, process.arch, process.versions.node)'
  npm ls --prod --depth 0 | grep loopback
-->

Expected Result

Issues template should be simple and easy to understand. Example / Proposed version below.

## Type
- [ ] Question
- [ ] Feature
- [ ] Bug / Issue

<!--
Bug / Issue => Include: Actual Result, Expected Result, Versions, Link to Sandbox (if available)
For Versions => Copy+Paste the output of these commands:
  node -e 'console.log(process.platform, process.arch, process.versions.node)'
  npm ls --prod --depth 0 | grep loopback
-->

## Description / Steps to Reproduce

Related to #47

@virkt25 virkt25 added developer-experience Issues affecting ease of use and overall experience of LB users suggestion labels Feb 8, 2018
@virkt25
Copy link
Contributor Author

virkt25 commented Feb 20, 2018

image

With the new CONTRIBUTING doc, I now see a message before making an issue. Wonder if new users see that and if it can mean a simpler template

@dhmlau
Copy link
Member

dhmlau commented Feb 26, 2018

I wonder if we want our users to include the package name / function area: https://github.com/strongloop/loopback-next/blob/master/MONOREPO.md#packages.

Just an example.. If someone is trying out the example-getting-started and having problem, it would help us by putting the pkg name on the title or the issue description. For obvious things, we can encourage them to put this info.

@raymondfeng
Copy link
Contributor

Let's create a PR to capture the proposed template. It will make the commenting/reviewing simpler.

@dhmlau
Copy link
Member

dhmlau commented Feb 26, 2018

I'll leave it as part of the task for #47 then.

@bajtos
Copy link
Member

bajtos commented Feb 27, 2018

I agree the current template is too complex and should be simplified 👍

## Type
- [ ] Question
- [ ] Feature
- [ ] Bug / Issue

Please don't use checklists as a replacement for radio buttons. GitHub shows completed + total number of items from checklists in GitHub issue list (see list of pull requests to see yourself). We don't want every user-reported issue to say "1 of 3" in the listing.

Regarding issue type in particular, we used to have a checklist like that in the past and it did not work well. In my experience, users often don't know what is the type of their report. Things that look like a bug to them may be considered as a missing feature by us. Discussions that start like a question can often evolve into a bug report or a feature request.

IMO, the issue template should ask the people to provide the information that is needed to meaningfully reproduce the issue on our side. This typically includes:

  • Steps to reproduce, including a sandbox app or at least code snippets
  • Actual result - what happened?
  • Expected result - what is the user expecting instead?
  • Version - LoopBack version, Node.js version, etc.
  • What workarounds has the user tried? What were the results?

I was filling a TypeScript issue recently, I found their template pretty nice and helpful even for myself as an issue reporter: https://raw.githubusercontent.com/Microsoft/TypeScript/master/issue_template.md

@bajtos
Copy link
Member

bajtos commented Feb 27, 2018

Regarding issue type in particular, we used to have a checklist like that in the past and it did not work well. In my experience, users often don't know what is the type of their report. Things that look like a bug to them may be considered as a missing feature by us. Discussions that start like a question can often evolve into a bug report or a feature request.

IMO, the issue template should ask the people to provide the information that is needed to meaningfully reproduce the issue on our side.

The decision whether an issue is considered a bug, feature or a question should be left up to us, maintainers/triagers to decide. We should use issue labels to mark an issue as a bug or a feature.

virkt25 added a commit that referenced this issue Mar 1, 2018
A proposal for a new issues template that is simpler and allows users to ask questions / provide feedback via issues.

fixes #979 and #47
@virkt25 virkt25 self-assigned this Mar 1, 2018
virkt25 added a commit that referenced this issue Mar 2, 2018
A proposal for a new issues template that is simpler and allows users to ask questions / provide feedback via issues.

fixes #979 and #47
virkt25 added a commit that referenced this issue Mar 2, 2018
A proposal for a new issues template that is simpler and allows users to ask questions / provide feedback via issues.

fixes #979 and #47
virkt25 added a commit that referenced this issue Mar 6, 2018
A proposal for a new issues template that is simpler and allows users to ask questions / provide feedback via issues.

fixes #979 and #47
virkt25 added a commit that referenced this issue Mar 7, 2018
A proposal for a new issues template that is simpler and allows users to ask questions / provide feedback via issues.

fixes #979 and #47
virkt25 added a commit that referenced this issue Mar 7, 2018
A proposal for a new issues template that is simpler and allows users to ask questions / provide feedback via issues.

fixes #979 and #47
virkt25 added a commit that referenced this issue Mar 8, 2018
A proposal for a new issues template that is simpler and allows users to ask questions / provide feedback via issues.

fixes #979 and #47
virkt25 added a commit that referenced this issue Mar 8, 2018
A proposal for a new issues template that is simpler and allows users to ask questions / provide feedback via issues.

fixes #979 and #47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
developer-experience Issues affecting ease of use and overall experience of LB users
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants