From 83612aac8f9b3607d59ba36e68c9774b9f9681e6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Miroslav=20Bajto=C5=A1?= Date: Fri, 4 Oct 2019 10:43:05 +0200 Subject: [PATCH 1/2] Improve PULL_REQUEST_TEMPLATE MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Make it easier for contributors to mix the text provided by GitHub from the commit messages with the template content. Rework the checklist to follow the style we use in loopback-next. Signed-off-by: Miroslav BajtoΕ‘ --- .github/PULL_REQUEST_TEMPLATE.md | 29 +++++++++++------------------ 1 file changed, 11 insertions(+), 18 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 368cb4cf..dd2753f4 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,25 +1,18 @@ -### Description - - -#### Related issues - -- connect to +## Checklist -### Checklist - - +πŸ‘‰ [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) From bd276d551a2661da2d9c489187544cc4bc8be42b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Miroslav=20Bajto=C5=A1?= Date: Fri, 4 Oct 2019 10:48:07 +0200 Subject: [PATCH 2/2] Introduce issue templates for bugs, features, etc. MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Miroslav BajtoΕ‘ --- .github/ISSUE_TEMPLATE.md | 37 ------------- .github/ISSUE_TEMPLATE/Bug_report.md | 53 +++++++++++++++++++ .github/ISSUE_TEMPLATE/Feature_request.md | 34 ++++++++++++ .github/ISSUE_TEMPLATE/Question.md | 27 ++++++++++ .../ISSUE_TEMPLATE/Security_vulnerability.md | 20 +++++++ 5 files changed, 134 insertions(+), 37 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/ISSUE_TEMPLATE/Bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/Feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/Question.md create mode 100644 .github/ISSUE_TEMPLATE/Security_vulnerability.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index 795176c4..00000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,37 +0,0 @@ - - -# Description/Steps to reproduce - - - -# Link to reproduction sandbox - - - -# Expected result - - - -# Additional information - - diff --git a/.github/ISSUE_TEMPLATE/Bug_report.md b/.github/ISSUE_TEMPLATE/Bug_report.md new file mode 100644 index 00000000..483c2eb5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Bug_report.md @@ -0,0 +1,53 @@ +--- +name: Bug report +about: Create a report to help us improve +labels: bug + +--- + + + +## Steps to reproduce + + + +## Current Behavior + + + +## Expected Behavior + + + +## Link to reproduction sandbox + + + +## Additional information + + + +## Related Issues + + + +_See [Reporting Issues](http://loopback.io/doc/en/contrib/Reporting-issues.html) for more tips on writing good issues_ diff --git a/.github/ISSUE_TEMPLATE/Feature_request.md b/.github/ISSUE_TEMPLATE/Feature_request.md new file mode 100644 index 00000000..f2d66b26 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Feature_request.md @@ -0,0 +1,34 @@ +--- +name: Feature request +about: Suggest an idea for this project +labels: feature + +--- + + + +## Suggestion + + + +## Use Cases + + + +## Examples + + + +## Acceptance criteria + +TBD - will be filled by the team. diff --git a/.github/ISSUE_TEMPLATE/Question.md b/.github/ISSUE_TEMPLATE/Question.md new file mode 100644 index 00000000..eb25195a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Question.md @@ -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 + +--- + + diff --git a/.github/ISSUE_TEMPLATE/Security_vulnerability.md b/.github/ISSUE_TEMPLATE/Security_vulnerability.md new file mode 100644 index 00000000..f82af367 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Security_vulnerability.md @@ -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 + +--- + +