From 643ff670a3c4831f73417a98e3fd043d56293df4 Mon Sep 17 00:00:00 2001 From: Larry Davis Date: Tue, 17 Sep 2019 08:52:08 -0700 Subject: [PATCH 1/8] docs: create issue templates --- .github/ISSUE_TEMPLATE/--bug-report.md | 36 +++++++++++++++++++ .../ISSUE_TEMPLATE/--documentation-issue.md | 19 ++++++++++ .github/ISSUE_TEMPLATE/-feature-request.md | 20 +++++++++++ 3 files changed, 75 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/--bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/--documentation-issue.md create mode 100644 .github/ISSUE_TEMPLATE/-feature-request.md diff --git a/.github/ISSUE_TEMPLATE/--bug-report.md b/.github/ISSUE_TEMPLATE/--bug-report.md new file mode 100644 index 00000000000..0bd1cc3d6c7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/--bug-report.md @@ -0,0 +1,36 @@ +--- +name: "\U0001F41BBug report" +about: Create a report to help us improve +title: '' +labels: bug +assignees: '' + +--- + +## Description + + + +## Steps to reproduce + +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +## Expected behavior + + + +## Screenshots + + + +## Environment + - Spectrum CSS version: [e.g. 2.13.0] + - OS: [e.g. iOS, macOS, Windows 10] + - Browser: [e.g. Chrome 75.0.3770.142 , Safari 12.1.2] + + +## Additional context + diff --git a/.github/ISSUE_TEMPLATE/--documentation-issue.md b/.github/ISSUE_TEMPLATE/--documentation-issue.md new file mode 100644 index 00000000000..62a2de5618a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/--documentation-issue.md @@ -0,0 +1,19 @@ +--- +name: "\U0001F4DADocumentation issue" +about: Describe this issue template's purpose here. +title: '' +labels: documentation +assignees: '' + +--- + +## Description + + + +## Link to documentation + + + +## Additional context + diff --git a/.github/ISSUE_TEMPLATE/-feature-request.md b/.github/ISSUE_TEMPLATE/-feature-request.md new file mode 100644 index 00000000000..38de9ba3df7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/-feature-request.md @@ -0,0 +1,20 @@ +--- +name: "✨Feature request" +about: Suggest an idea for this project +title: '' +labels: enhancement +assignees: '' + +--- + +## Is your feature request related to a problem? +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +## Describe the solution you'd like +A clear and concise description of what you want to happen. + +## Describe alternatives you've considered +A clear and concise description of any alternative solutions or features you've considered. + +## Additional context +Add any other context or screenshots about the feature request here. From 823124260eff7550a18ab5af7ef968fd0d14e65d Mon Sep 17 00:00:00 2001 From: Larry Davis Date: Tue, 17 Sep 2019 08:54:53 -0700 Subject: [PATCH 2/8] docs: update documentation issuen template --- .github/ISSUE_TEMPLATE/--documentation-issue.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/--documentation-issue.md b/.github/ISSUE_TEMPLATE/--documentation-issue.md index 62a2de5618a..dccf0aecb07 100644 --- a/.github/ISSUE_TEMPLATE/--documentation-issue.md +++ b/.github/ISSUE_TEMPLATE/--documentation-issue.md @@ -1,6 +1,6 @@ --- -name: "\U0001F4DADocumentation issue" -about: Describe this issue template's purpose here. +name: "📚 Documentation issue" +about: Report an issue with the project documentation title: '' labels: documentation assignees: '' From 664cc58044087f34c6d8c702b0696349e84a5f34 Mon Sep 17 00:00:00 2001 From: Larry Davis Date: Tue, 17 Sep 2019 08:55:55 -0700 Subject: [PATCH 3/8] docs: update bug report template --- .github/ISSUE_TEMPLATE/--bug-report.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/--bug-report.md b/.github/ISSUE_TEMPLATE/--bug-report.md index 0bd1cc3d6c7..e8d098ecdc1 100644 --- a/.github/ISSUE_TEMPLATE/--bug-report.md +++ b/.github/ISSUE_TEMPLATE/--bug-report.md @@ -1,6 +1,6 @@ --- -name: "\U0001F41BBug report" -about: Create a report to help us improve +name: "🐛 Bug report" +about: Report a problem with Spectrum CSS title: '' labels: bug assignees: '' From e3f6261a11ca6e7bbd127d407ca7cc01067c6c40 Mon Sep 17 00:00:00 2001 From: Larry Davis Date: Tue, 17 Sep 2019 09:07:53 -0700 Subject: [PATCH 4/8] docs: drop old issue template, emoji-tuning, rename feature template --- .github/ISSUE_TEMPLATE.md | 15 --------------- .github/ISSUE_TEMPLATE/--bug-report.md | 2 +- .github/ISSUE_TEMPLATE/--documentation-issue.md | 2 +- .../{-feature-request.md => --feature-request.md} | 0 4 files changed, 2 insertions(+), 17 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE.md rename .github/ISSUE_TEMPLATE/{-feature-request.md => --feature-request.md} (100%) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index 3b5eb2c562c..00000000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,15 +0,0 @@ -### Expected Behavior - -### Actual Behavior - -### Reproduce Scenario (including but not limited to) - -#### Steps to Reproduce - -#### Browser name/version/os (ie Chrome Version 62.0.3202.94 (Official Build) (64-bit) MacOS) - -#### Spectrum-CSS version - -#### Sample Code that illustrates the problem - -#### Screenshots (if applicable) diff --git a/.github/ISSUE_TEMPLATE/--bug-report.md b/.github/ISSUE_TEMPLATE/--bug-report.md index e8d098ecdc1..2c8a27b08ed 100644 --- a/.github/ISSUE_TEMPLATE/--bug-report.md +++ b/.github/ISSUE_TEMPLATE/--bug-report.md @@ -1,5 +1,5 @@ --- -name: "🐛 Bug report" +name: "🐛Bug report" about: Report a problem with Spectrum CSS title: '' labels: bug diff --git a/.github/ISSUE_TEMPLATE/--documentation-issue.md b/.github/ISSUE_TEMPLATE/--documentation-issue.md index dccf0aecb07..80e07aebccf 100644 --- a/.github/ISSUE_TEMPLATE/--documentation-issue.md +++ b/.github/ISSUE_TEMPLATE/--documentation-issue.md @@ -1,5 +1,5 @@ --- -name: "📚 Documentation issue" +name: "📚Documentation issue" about: Report an issue with the project documentation title: '' labels: documentation diff --git a/.github/ISSUE_TEMPLATE/-feature-request.md b/.github/ISSUE_TEMPLATE/--feature-request.md similarity index 100% rename from .github/ISSUE_TEMPLATE/-feature-request.md rename to .github/ISSUE_TEMPLATE/--feature-request.md From b0ac60ad203ddbded8dd8ed39b1586f4dbac74d3 Mon Sep 17 00:00:00 2001 From: Larry Davis Date: Tue, 17 Sep 2019 10:13:11 -0700 Subject: [PATCH 5/8] docs: add support template --- .github/ISSUE_TEMPLATE/--support-request.md | 24 +++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/--support-request.md diff --git a/.github/ISSUE_TEMPLATE/--support-request.md b/.github/ISSUE_TEMPLATE/--support-request.md new file mode 100644 index 00000000000..244847fcc75 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/--support-request.md @@ -0,0 +1,24 @@ +--- +name: "📚Support request" +about: Questions and requests for support +title: '' +labels: question +assignees: '' + +--- + +## Description + + + +## Screenshots + + + +## Environment + - Spectrum CSS version: [e.g. 2.13.0] + - OS: [e.g. iOS, macOS, Windows 10] + - Browser: [e.g. Chrome 75.0.3770.142 , Safari 12.1.2] + +## Additional context + From f3c55381185fe9d57ed13c073ed3be0319fac2ff Mon Sep 17 00:00:00 2001 From: Larry Davis Date: Wed, 18 Sep 2019 13:04:08 -0700 Subject: [PATCH 6/8] docs: implement feedback from PR --- .github/ISSUE_TEMPLATE/--bug-report.md | 8 ++++---- .github/ISSUE_TEMPLATE/--documentation-issue.md | 4 ++-- .github/ISSUE_TEMPLATE/--feature-request.md | 15 +++++++-------- .github/ISSUE_TEMPLATE/--support-request.md | 2 +- 4 files changed, 14 insertions(+), 15 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/--bug-report.md b/.github/ISSUE_TEMPLATE/--bug-report.md index 2c8a27b08ed..a9337729a26 100644 --- a/.github/ISSUE_TEMPLATE/--bug-report.md +++ b/.github/ISSUE_TEMPLATE/--bug-report.md @@ -13,10 +13,10 @@ assignees: '' ## Steps to reproduce -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error +1. Go to http://opensource.corp.adobe.com/spectrum-css/ +2. Click on ... +3. Observe ... + ## Expected behavior diff --git a/.github/ISSUE_TEMPLATE/--documentation-issue.md b/.github/ISSUE_TEMPLATE/--documentation-issue.md index 80e07aebccf..91a8532c1df 100644 --- a/.github/ISSUE_TEMPLATE/--documentation-issue.md +++ b/.github/ISSUE_TEMPLATE/--documentation-issue.md @@ -8,11 +8,11 @@ assignees: '' --- ## Description - + ## Link to documentation - + ## Additional context diff --git a/.github/ISSUE_TEMPLATE/--feature-request.md b/.github/ISSUE_TEMPLATE/--feature-request.md index 38de9ba3df7..f936a9896a6 100644 --- a/.github/ISSUE_TEMPLATE/--feature-request.md +++ b/.github/ISSUE_TEMPLATE/--feature-request.md @@ -1,20 +1,19 @@ --- name: "✨Feature request" -about: Suggest an idea for this project +about: Suggest a feature or new component title: '' labels: enhancement assignees: '' --- -## Is your feature request related to a problem? -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] +## Describe the feature in detail and any related problems it solves + -## Describe the solution you'd like -A clear and concise description of what you want to happen. -## Describe alternatives you've considered -A clear and concise description of any alternative solutions or features you've considered. +## Describe alternatives or workarounds + + ## Additional context -Add any other context or screenshots about the feature request here. + diff --git a/.github/ISSUE_TEMPLATE/--support-request.md b/.github/ISSUE_TEMPLATE/--support-request.md index 244847fcc75..bf2af50dd65 100644 --- a/.github/ISSUE_TEMPLATE/--support-request.md +++ b/.github/ISSUE_TEMPLATE/--support-request.md @@ -8,7 +8,7 @@ assignees: '' --- ## Description - + ## Screenshots From 08d5b66652e225fbb2e010fd142c3b6a2210368a Mon Sep 17 00:00:00 2001 From: Larry Davis Date: Wed, 18 Sep 2019 14:50:25 -0700 Subject: [PATCH 7/8] docs: implement feedback from content strategies --- .github/ISSUE_TEMPLATE/--bug-report.md | 15 ++++++++------- .github/ISSUE_TEMPLATE/--documentation-issue.md | 9 +++++---- .github/ISSUE_TEMPLATE/--feature-request.md | 15 ++++++++------- .github/ISSUE_TEMPLATE/--support-request.md | 17 +++++++++-------- 4 files changed, 30 insertions(+), 26 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/--bug-report.md b/.github/ISSUE_TEMPLATE/--bug-report.md index a9337729a26..cbc7411d5a3 100644 --- a/.github/ISSUE_TEMPLATE/--bug-report.md +++ b/.github/ISSUE_TEMPLATE/--bug-report.md @@ -1,5 +1,5 @@ --- -name: "🐛Bug report" +name: "🐛 Bug report" about: Report a problem with Spectrum CSS title: '' labels: bug @@ -8,7 +8,7 @@ assignees: '' --- ## Description - + ## Steps to reproduce @@ -19,7 +19,7 @@ assignees: '' ## Expected behavior - + ## Screenshots @@ -27,10 +27,11 @@ assignees: '' ## Environment - - Spectrum CSS version: [e.g. 2.13.0] - - OS: [e.g. iOS, macOS, Windows 10] - - Browser: [e.g. Chrome 75.0.3770.142 , Safari 12.1.2] + - Spectrum CSS version: + - OS: + - Browser(s): ## Additional context - + + diff --git a/.github/ISSUE_TEMPLATE/--documentation-issue.md b/.github/ISSUE_TEMPLATE/--documentation-issue.md index 91a8532c1df..327adb54c1f 100644 --- a/.github/ISSUE_TEMPLATE/--documentation-issue.md +++ b/.github/ISSUE_TEMPLATE/--documentation-issue.md @@ -1,5 +1,5 @@ --- -name: "📚Documentation issue" +name: "📚 Documentation issue" about: Report an issue with the project documentation title: '' labels: documentation @@ -8,12 +8,13 @@ assignees: '' --- ## Description - + ## Link to documentation - + ## Additional context - + + diff --git a/.github/ISSUE_TEMPLATE/--feature-request.md b/.github/ISSUE_TEMPLATE/--feature-request.md index f936a9896a6..79d554f8620 100644 --- a/.github/ISSUE_TEMPLATE/--feature-request.md +++ b/.github/ISSUE_TEMPLATE/--feature-request.md @@ -1,19 +1,20 @@ --- -name: "✨Feature request" -about: Suggest a feature or new component +name: "✨ Feature request" +about: Suggest a new feature or component title: '' labels: enhancement assignees: '' --- -## Describe the feature in detail and any related problems it solves - +## Description + -## Describe alternatives or workarounds - +## Why do you need this feature or component? + ## Additional context - + + diff --git a/.github/ISSUE_TEMPLATE/--support-request.md b/.github/ISSUE_TEMPLATE/--support-request.md index bf2af50dd65..86c65516f64 100644 --- a/.github/ISSUE_TEMPLATE/--support-request.md +++ b/.github/ISSUE_TEMPLATE/--support-request.md @@ -1,6 +1,6 @@ --- -name: "📚Support request" -about: Questions and requests for support +name: "📚 Support request" +about: Ask for help with using Spectrum CSS title: '' labels: question assignees: '' @@ -8,17 +8,18 @@ assignees: '' --- ## Description - + ## Screenshots - + ## Environment - - Spectrum CSS version: [e.g. 2.13.0] - - OS: [e.g. iOS, macOS, Windows 10] - - Browser: [e.g. Chrome 75.0.3770.142 , Safari 12.1.2] + - Spectrum CSS version: + - OS: + - Browser(s): ## Additional context - + + From 12f4912870ba5bd8c2756e4ffeec109399778915 Mon Sep 17 00:00:00 2001 From: Larry Davis Date: Wed, 18 Sep 2019 17:19:14 -0700 Subject: [PATCH 8/8] docs: combine browsers and OS fields --- .github/ISSUE_TEMPLATE/--bug-report.md | 4 +--- .github/ISSUE_TEMPLATE/--support-request.md | 3 +-- 2 files changed, 2 insertions(+), 5 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/--bug-report.md b/.github/ISSUE_TEMPLATE/--bug-report.md index cbc7411d5a3..81d73494887 100644 --- a/.github/ISSUE_TEMPLATE/--bug-report.md +++ b/.github/ISSUE_TEMPLATE/--bug-report.md @@ -28,9 +28,7 @@ assignees: '' ## Environment - Spectrum CSS version: - - OS: - - Browser(s): - + - Browser(s) and OS(s): ## Additional context diff --git a/.github/ISSUE_TEMPLATE/--support-request.md b/.github/ISSUE_TEMPLATE/--support-request.md index 86c65516f64..a85591128a4 100644 --- a/.github/ISSUE_TEMPLATE/--support-request.md +++ b/.github/ISSUE_TEMPLATE/--support-request.md @@ -17,8 +17,7 @@ assignees: '' ## Environment - Spectrum CSS version: - - OS: - - Browser(s): + - Browser and OS: ## Additional context