-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
Comments
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 |
Let's create a PR to capture the proposed template. It will make the commenting/reviewing simpler. |
I'll leave it as part of the task for #47 then. |
I agree the current template is too complex and should be simplified 👍
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:
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 |
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. |
I think the current issues template is super complicated and cluttered, making it harder to create an issue. See below for the original template.
Expected Result
Issues template should be simple and easy to understand. Example / Proposed version below.
Related to #47
The text was updated successfully, but these errors were encountered: