Skip to content

Commit edb9255

Browse files
bajtosbajtos
authored
Merge pull request #4266 from strongloop/improve/github-templates
Improve issue & pull-request templates
2 parents af9f776 + bd276d5 commit edb9255

File tree

6 files changed

+145
-55
lines changed

6 files changed

+145
-55
lines changed

‎.github/ISSUE_TEMPLATE.md

Lines changed: 0 additions & 37 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/Bug_report.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
labels: bug
5+
6+
---
7+
8+
<!-- 🚨 STOP 🚨 STOP 🚨 STOP 🚨
9+
10+
Are you using LoopBack version 4? Please report the bug here:
11+
https://github.com/strongloop/loopback-next/issues/new
12+
13+
HELP US HELP YOU, PLEASE
14+
- Do a quick search to avoid duplicate issues
15+
- Provide as much information as possible (reproduction sandbox, use case for features, etc.)
16+
- Consider using a more suitable venue for questions such as Stack Overflow, Gitter, etc.
17+
18+
Please fill in the *entire* template below.
19+
20+
-->
21+
22+
## Steps to reproduce
23+
24+
<!-- Describe how to reproduce the issue -->
25+
26+
## Current Behavior
27+
28+
<!-- Describe the observed result -->
29+
30+
## Expected Behavior
31+
32+
<!-- Describe what did you expect instead, what is the desired outcome? -->
33+
34+
## Link to reproduction sandbox
35+
36+
<!--
37+
See https://loopback.io/doc/en/contrib/Reporting-issues.html#loopback-3x-bugs
38+
Note: Failure to provide a sandbox application for reproduction purposes will result in the issue being closed.
39+
-->
40+
41+
## Additional information
42+
43+
<!--
44+
Copy+paste the output of these two commands:
45+
node -e 'console.log(process.platform, process.arch, process.versions.node)'
46+
npm ls --prod --depth 0 | grep loopback
47+
-->
48+
49+
## Related Issues
50+
51+
<!-- Did you find other bugs that looked similar? -->
52+
53+
_See [Reporting Issues](http://loopback.io/doc/en/contrib/Reporting-issues.html) for more tips on writing good issues_

‎.github/ISSUE_TEMPLATE/Feature_request.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
labels: feature
5+
6+
---
7+
8+
<!-- 🚨 STOP 🚨 STOP 🚨 STOP 🚨
9+
10+
LoopBack version 3 is in LTS mode, we are not accepting new features.
11+
12+
We are actively developing version 4, you can find the new GitHub
13+
repository here: https://github.com/strongloop/loopback-next
14+
15+
-->
16+
17+
## Suggestion
18+
19+
<!-- A summary of what you'd like to see added or changed -->
20+
21+
## Use Cases
22+
23+
<!--
24+
What do you want to use this for?
25+
What shortcomings exist with current approaches?
26+
-->
27+
28+
## Examples
29+
30+
<!-- Show how this would be used and what the behavior would be -->
31+
32+
## Acceptance criteria
33+
34+
TBD - will be filled by the team.

‎.github/ISSUE_TEMPLATE/Question.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
name: Question
3+
about: The issue tracker is not for questions. Please use Stack Overflow or other resources for help.
4+
labels: question
5+
6+
---
7+
8+
<!-- 🚨 STOP 🚨 STOP 🚨 STOP 🚨
9+
10+
THE ISSUE TRACKER IS NOT FOR QUESTIONS.
11+
12+
DO NOT CREATE A NEW ISSUE TO ASK A QUESTION.
13+
14+
Please use one of the following resources for help:
15+
16+
**Questions**
17+
18+
- https://stackoverflow.com/tags/loopbackjs
19+
- https://groups.google.com/forum/#!forum/loopbackjs
20+
- https://gitter.im/strongloop/loopback
21+
22+
**Immediate support**
23+
24+
- https://strongloop.com/api-connect-faqs/
25+
- https://strongloop.com/node-js/subscription-plans/
26+
27+
-->

‎.github/ISSUE_TEMPLATE/Security_vulnerability.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Security vulnerability
3+
about: Do not report security vulnerabilities using GitHub issues. Please send an email to `[email protected]` instead.
4+
labels: security
5+
6+
---
7+
8+
<!-- 🚨 STOP 🚨 STOP 🚨 STOP 🚨
9+
10+
BE RESPONSIBLE WHEN REPORTING SECURITY VULNERABILITIES.
11+
USE A PRIVATE CHANNEL TO ALLOW THE VULNERABILITY TO BE
12+
FIXED BEFORE IT'S PUBLICIZED.
13+
14+
Please send an email to `[email protected]` with:
15+
16+
- Description of the vulnerability.
17+
- Steps to reproduce the issue.
18+
- Possible solutions.
19+
20+
-->

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 11 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,18 @@
1-
### Description
2-
3-
4-
#### Related issues
5-
61
<!--
7-
Please use the following link syntaxes:
2+
Please provide a high-level description of the changes made by your pull request.
83
9-
- connect to #49 (to reference issues in the current repository)
10-
- connect to strongloop/loopback#49 (to reference issues in another repository)
11-
-->
4+
Include references to all related GitHub issues and other pull requests, for example:
125
13-
- connect to <link_to_referenced_issue>
6+
Fixes #123
7+
Implements #254
8+
See also #23
9+
-->
1410

15-
### Checklist
11+
## Checklist
1612

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

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

0 commit comments

Comments
 (0)