From 86d41a1db90f0f9ead61f3d9fa250c1ce50e7847 Mon Sep 17 00:00:00 2001 From: Igor Minar Date: Fri, 2 Nov 2018 14:58:20 +0100 Subject: [PATCH] docs: new GitHub Issue templates (#26918) These templates take advatange of github's feature that allows us to define multiple templates and which the UI presents to the user and lets them choose the most appropriate template. The goal of this is to tailor the templates to the templates to various use-cases and bug categories and provide better guidance to developers filing issues which should result in more efficient processing of the issue backlog. PR Close #26918 --- .github/ISSUE_TEMPLATE.md | 61 ++---------------- .github/ISSUE_TEMPLATE/1-bug-report.md | 63 +++++++++++++++++++ .github/ISSUE_TEMPLATE/2-feature-request.md | 32 ++++++++++ .github/ISSUE_TEMPLATE/3-docs-bug.md | 55 ++++++++++++++++ .../4-security-issue-disclosure.md | 11 ++++ .github/ISSUE_TEMPLATE/5-support-request.md | 16 +++++ .github/ISSUE_TEMPLATE/6-angular-cli.md | 13 ++++ .github/ISSUE_TEMPLATE/7-angular-material.md | 13 ++++ 8 files changed, 209 insertions(+), 55 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/1-bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/2-feature-request.md create mode 100644 .github/ISSUE_TEMPLATE/3-docs-bug.md create mode 100644 .github/ISSUE_TEMPLATE/4-security-issue-disclosure.md create mode 100644 .github/ISSUE_TEMPLATE/5-support-request.md create mode 100644 .github/ISSUE_TEMPLATE/6-angular-cli.md create mode 100644 .github/ISSUE_TEMPLATE/7-angular-material.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index ac818aa530..625de624e7 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,59 +1,10 @@ - +Please help us process issues more efficiently by filing an +issue using one of the following templates: -## I'm submitting a... - -

-[ ] Regression (a behavior that used to work and stopped working in a new release)
-[ ] Bug report  
-[ ] Performance issue
-[ ] Feature request
-[ ] Documentation issue or request
-[ ] Support request => Please do not submit support request here, instead see https://github.com/angular/angular/blob/master/CONTRIBUTING.md#question
-[ ] Other... Please describe:
-
+https://github.com/angular/angular/issues/new/choose -## Current behavior - +Thank you! - -## Expected behavior - - - -## Minimal reproduction of the problem with instructions - - -## What is the motivation / use case for changing the behavior? - - - -## Environment - -

-Angular version: X.Y.Z
-
-
-Browser:
-- [ ] Chrome (desktop) version XX
-- [ ] Chrome (Android) version XX
-- [ ] Chrome (iOS) version XX
-- [ ] Firefox version XX
-- [ ] Safari (desktop) version XX
-- [ ] Safari (iOS) version XX
-- [ ] IE version XX
-- [ ] Edge version XX
- 
-For Tooling issues:
-- Node version: XX  
-- Platform:  
-
-Others:
-
-
+πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘ diff --git a/.github/ISSUE_TEMPLATE/1-bug-report.md b/.github/ISSUE_TEMPLATE/1-bug-report.md new file mode 100644 index 0000000000..2ec94c966e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1-bug-report.md @@ -0,0 +1,63 @@ +--- +name: "\U0001F41EBug report" +about: Report a bug in the Angular Framework +--- + + + +# 🐞 bug report + +### Affected Package + + The issue is caused by package @angular/.... + + +### Is this a regression? + + + Yes, the previous version in which this bug was not present was: .... + + +### Description + + A clear and concise description of the problem... + + +## πŸ”¬ Minimal Reproduction + + https://stackblitz.com/... + + + +## πŸ”₯ Exception or Error +

+
+
+
+
+ + +## 🌍 Your Environment + +**Angular Version:** +

+
+
+
+
+ +**Anything else relevant?** + + + diff --git a/.github/ISSUE_TEMPLATE/2-feature-request.md b/.github/ISSUE_TEMPLATE/2-feature-request.md new file mode 100644 index 0000000000..a408ca988f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2-feature-request.md @@ -0,0 +1,32 @@ +--- +name: "\U0001F680Feature request" +about: Suggest a feature for Angular Framework + +--- + + + +# πŸš€ feature request + +### Releavant Package + + This feature request is for @angular/.... + + +### Description + A clear and concise description of the problem or missing capability... + + +### Describe the solution you'd like + If you have a solution in mind, please describe it. + + +### Describe alternatives you've considered + Have you considered any alternative solutions or workarounds? diff --git a/.github/ISSUE_TEMPLATE/3-docs-bug.md b/.github/ISSUE_TEMPLATE/3-docs-bug.md new file mode 100644 index 0000000000..c7ed324cce --- /dev/null +++ b/.github/ISSUE_TEMPLATE/3-docs-bug.md @@ -0,0 +1,55 @@ +--- +name: "πŸ“š Docs or angular.io issue report" +about: Report an issue in Angular's documentation or angular.io application + +--- + + +# πŸ“š Docs or angular.io bug report + +### Description + + A clear and concise description of the problem... + + +## πŸ”¬ Minimal Reproduction + +### What's the affected URL?** + https://angular.io/... + +### Reproduction Steps** + + + +### Expected vs Actual Behavior** + + + + +## πŸ“·Screenshot + + + + +## πŸ”₯ Exception or Error +

+
+
+
+
+ + +## 🌍 Your Environment + +### Browser info + + +### Anything else relevant? + diff --git a/.github/ISSUE_TEMPLATE/4-security-issue-disclosure.md b/.github/ISSUE_TEMPLATE/4-security-issue-disclosure.md new file mode 100644 index 0000000000..70736318d2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/4-security-issue-disclosure.md @@ -0,0 +1,11 @@ +--- +name: ⚠️ Security issue disclosure +about: Report a security issue in Angular Framework, Material, or CLI + +--- + +πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘ + +Please read https://angular.io/guide/security#report-issues on how to disclose security related issues. + +πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘ diff --git a/.github/ISSUE_TEMPLATE/5-support-request.md b/.github/ISSUE_TEMPLATE/5-support-request.md new file mode 100644 index 0000000000..2dbeb30612 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/5-support-request.md @@ -0,0 +1,16 @@ +--- +name: "❓Support request" +about: Questions and requests for support + +--- + +πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘ + +Please do not file questions or support requests on the GitHub issues tracker. + +You can get your questions answered using other communication channels. Please see: +https://github.com/angular/angular/blob/master/CONTRIBUTING.md#question + +Thank you! + +πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘ diff --git a/.github/ISSUE_TEMPLATE/6-angular-cli.md b/.github/ISSUE_TEMPLATE/6-angular-cli.md new file mode 100644 index 0000000000..8bad6e69cd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/6-angular-cli.md @@ -0,0 +1,13 @@ +--- +name: "\U0001F6E0️Angular CLI" +about: Issues and feature requests for Angular CLI + +--- + +πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘ + +Please file any Angular CLI issues at: https://github.com/angular/angular-cli/issues/new + +For the time being, we keep Angular CLI issues in a separate repository. + +πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘ diff --git a/.github/ISSUE_TEMPLATE/7-angular-material.md b/.github/ISSUE_TEMPLATE/7-angular-material.md new file mode 100644 index 0000000000..b023135b0c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/7-angular-material.md @@ -0,0 +1,13 @@ +--- +name: "\U0001F48EAngular Material" +about: Issues and feature requests for Angular Material + +--- + +πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘ + +Please file any Angular Material issues at: https://github.com/angular/material2/issues/new + +For the time being, we keep Angular Material issues in a separate repository. + +πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘πŸ›‘