Improve issue & pull-request templates #4266

Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,53 @@
	---
	name: Bug report
	about: Create a report to help us improve
	labels: bug

	---

	<!-- 🚨 STOP 🚨 STOP 🚨 STOP 🚨
Comment thread bajtos marked this conversation as resolved.

	Are you using LoopBack version 4? Please report the bug here:
	https://github.com/strongloop/loopback-next/issues/new

	HELP US HELP YOU, PLEASE
	- Do a quick search to avoid duplicate issues
	- Provide as much information as possible (reproduction sandbox, use case for features, etc.)
	- Consider using a more suitable venue for questions such as Stack Overflow, Gitter, etc.

	Please fill in the entire template below.

	-->

	## Steps to reproduce

	<!-- Describe how to reproduce the issue -->

	## Current Behavior

	<!-- Describe the observed result -->

	## Expected Behavior

	<!-- Describe what did you expect instead, what is the desired outcome? -->

	## Link to reproduction sandbox

	<!--
	See https://loopback.io/doc/en/contrib/Reporting-issues.html#loopback-3x-bugs
	Note: Failure to provide a sandbox application for reproduction purposes will result in the issue being closed.
	-->

	## 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
	-->

	## Related Issues

	<!-- Did you find other bugs that looked similar? -->

	_See [Reporting Issues](http://loopback.io/doc/en/contrib/Reporting-issues.html) for more tips on writing good issues_

34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/Feature_request.md

Show comments View file Open in desktop

Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,34 @@
	---
	name: Feature request
	about: Suggest an idea for this project
	labels: feature

	---

	<!-- 🚨 STOP 🚨 STOP 🚨 STOP 🚨

	LoopBack version 3 is in LTS mode, we are not accepting new features.
Comment thread bajtos marked this conversation as resolved.

	We are actively developing version 4, you can find the new GitHub
	repository here: https://github.com/strongloop/loopback-next

	-->

	## Suggestion

	<!-- A summary of what you'd like to see added or changed -->

	## Use Cases

	<!--
	What do you want to use this for?
	What shortcomings exist with current approaches?
	-->

	## Examples

	<!-- Show how this would be used and what the behavior would be -->

	## Acceptance criteria

	TBD - will be filled by the team.

27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/Question.md

Show comments View file Open in desktop

Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,27 @@
	---
	name: Question
	about: The issue tracker is not for questions. Please use Stack Overflow or other resources for help.
	labels: question

	---

	<!-- 🚨 STOP 🚨 STOP 🚨 STOP 🚨

	THE ISSUE TRACKER IS NOT FOR QUESTIONS.

	DO NOT CREATE A NEW ISSUE TO ASK A QUESTION.

	Please use one of the following resources for help:

	Questions

	- https://stackoverflow.com/tags/loopbackjs
	- 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/

	-->

20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/Security_vulnerability.md

Show comments View file Open in desktop

Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,20 @@
	---
	name: Security vulnerability
	about: Do not report security vulnerabilities using GitHub issues. Please send an email to `reachsl@us.ibm.com` instead.
	labels: security

	---

	<!-- 🚨 STOP 🚨 STOP 🚨 STOP 🚨

	BE RESPONSIBLE WHEN REPORTING SECURITY VULNERABILITIES.
	USE A PRIVATE CHANNEL TO ALLOW THE VULNERABILITY TO BE
	FIXED BEFORE IT'S PUBLICIZED.

	Please send an email to `reachsl@us.ibm.com` with:

	- Description of the vulnerability.
	- Steps to reproduce the issue.
	- Possible solutions.

	-->

29 changes: 11 additions & 18 deletions .github/PULL_REQUEST_TEMPLATE.md

Show comments View file Open in desktop

Original file line number	Diff line number	Diff line change
		@@ -1,25 +1,18 @@
	### Description


	#### Related issues

		<!--
	Please use the following link syntaxes:
	Please provide a high-level description of the changes made by your pull request.

	- connect to #49 (to reference issues in the current repository)
	- connect to strongloop/loopback#49 (to reference issues in another repository)
	-->
	Include references to all related GitHub issues and other pull requests, for example:

	- connect to <link_to_referenced_issue>
	Fixes #123
	Implements #254
	See also #23
	-->

	### Checklist
	## Checklist

	<!--
	- Please mark your choice with an "x" (i.e. [x], see
	https://github.com/blog/1375-task-lists-in-gfm-issues-pulls-comments)
	- PR's without test coverage will be closed.
	-->
	👉 [Read and sign the CLA (Contributor License Agreement)](https://cla.strongloop.com/agreements/strongloop/loopback) 👈

	- [ ] `npm test` passes on your machine
		- [ ] New tests added or existing tests modified to cover all changes
	- [ ] Code conforms with the [style
	guide](http://loopback.io/doc/en/contrib/style-guide.html)
	- [ ] Code conforms with the [style guide](https://loopback.io/doc/en/contrib/style-guide-es6.html)
	- [ ] Commit messages are following our [guidelines](https://loopback.io/doc/en/contrib/git-commit-messages.html)

Navigation Menu