This is an automated email from the ASF dual-hosted git repository.
rawlin pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/trafficcontrol.git
The following commit(s) were added to refs/heads/master by this push:
new d13a79e Separate bug, feature request, and improvement request issue
templates (#5047)
d13a79e is described below
commit d13a79e52b10dbcedcaef9891d3e9a634843d370
Author: Zach Hoffman <[email protected]>
AuthorDate: Thu Sep 24 10:41:59 2020 -0600
Separate bug, feature request, and improvement request issue templates
(#5047)
* Split bug report and feature/improvement request into 2 separate issue
templates
* Add issue contact links
* Number issue templates
* Wording: slack channels -> slack
* Separate feature request and improvement request templates
* Use the improvement label for improvements
* Remove www from license URL and make https
* Put <!-- and --> on separate lines for multiline comments
* Add security vulnerability instructions to all issue templates
* Re-add "I'm submitting a ..." section to all issue templates
* Expand on the purpose of improvement requests
---
.../ISSUE_TEMPLATE/1-bug-report.md | 38 +++++++----
.github/ISSUE_TEMPLATE/2-feature-request.md | 79 ++++++++++++++++++++++
.github/ISSUE_TEMPLATE/3-improvement-request.md | 79 ++++++++++++++++++++++
.github/ISSUE_TEMPLATE/config.yml | 21 ++++++
.github/workflows/ciab.yaml | 2 +
5 files changed, 206 insertions(+), 13 deletions(-)
diff --git a/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE/1-bug-report.md
similarity index 63%
rename from ISSUE_TEMPLATE.md
rename to .github/ISSUE_TEMPLATE/1-bug-report.md
index 253823a..f348e20 100644
--- a/ISSUE_TEMPLATE.md
+++ b/.github/ISSUE_TEMPLATE/1-bug-report.md
@@ -1,19 +1,27 @@
+---
+name: Bug report
+
+about: Report an issue with the current behavior of Traffic Control
+
+labels: bug
+
+---
+
<!--
************ STOP!! ************
If this issue identifies a security vulnerability, DO NOT submit it! Instead,
contact
-the Apache Software Foundation Security Team at
[email protected] and follow the
+the Apache Traffic Control Security Team at [email protected]
and follow the
guidelines at https://www.apache.org/security/ regarding vulnerability
disclosure.
-- For *SUPPORT QUESTIONS*, use the
-[Traffic Control slack channels](https://traffic-control-cdn.slack.com) or
[Traffic Control mailing
lists](http://trafficcontrol.apache.org/mailing_lists/).
-- Before submitting, please **SEARCH GITHUB** for a similar issue or PR. -->
+- For *SUPPORT QUESTIONS*, use the Traffic Control slack
(https://s.apache.org/atc-slack)
+or Traffic Control mailing lists
(https://trafficcontrol.apache.org/mailing_lists).
+- Before submitting, please **SEARCH GITHUB** for a similar issue or PR.
+-->
## I'm submitting a ...
<!-- delete all those that don't apply -->
<!--- security vulnerability (STOP!! - see above)-->
- bug report
-- new feature / enhancement request
-- improvement request (usability, performance, tech debt, etc.)
- other <!--(Please do not submit support requests here - see above)-->
## Traffic Control components affected ...
@@ -29,22 +37,26 @@ guidelines at https://www.apache.org/security/ regarding
vulnerability disclosur
- Traffic Router
- Traffic Stats
- Traffic Vault
+- CI tests
- unknown
## Current behavior:
-<!-- Describe how the bug manifests / how the current features are
insufficient. -->
+<!-- Describe how the bug manifests -->
-## Expected / new behavior:
-<!-- Describe what the behavior would be without the bug / how the feature
would improve Traffic Control -->
+## Expected behavior:
+<!-- Describe what the behavior would be without the bug -->
## Minimal reproduction of the problem with instructions:
<!--
-If the current behavior is a bug or you can illustrate your feature request
better with an example,
-please provide the *STEPS TO REPRODUCE* and include the applicable TC version.
+If the current behavior is a bug, please provide the *STEPS TO REPRODUCE* and
+include the applicable TC version.
-->
## Anything else:
-<!-- e.g. stacktraces, related issues, suggestions how to fix -->
+<!--
+e.g. stacktraces, related issues, suggestions how to fix (feel free to delete
+this section)
+-->
<!--
Licensed to the Apache Software Foundation (ASF) under one
@@ -55,7 +67,7 @@ to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
- http://www.apache.org/licenses/LICENSE-2.0
+ https://apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
diff --git a/.github/ISSUE_TEMPLATE/2-feature-request.md
b/.github/ISSUE_TEMPLATE/2-feature-request.md
new file mode 100644
index 0000000..ae77665
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/2-feature-request.md
@@ -0,0 +1,79 @@
+---
+name: Feature request
+
+about: Suggest how to improve Traffic Control with something new
+
+labels: enhancement
+
+---
+
+<!--
+************ STOP!! ************
+If this issue identifies a security vulnerability, DO NOT submit it! Instead,
contact
+the Apache Traffic Control Security Team at [email protected]
and follow the
+guidelines at https://www.apache.org/security/ regarding vulnerability
disclosure.
+
+- For *SUPPORT QUESTIONS*, use the Traffic Control slack
(https://s.apache.org/atc-slack)
+or Traffic Control mailing lists
(https://trafficcontrol.apache.org/mailing_lists).
+- Before submitting, please **SEARCH GITHUB** for a similar issue or PR.
+-->
+
+## I'm submitting a ...
+<!-- delete all those that don't apply -->
+<!--- security vulnerability (STOP!! - see above)-->
+- new feature / enhancement request
+- other <!--(Please do not submit support requests here - see above)-->
+
+## Traffic Control components affected ...
+<!-- delete all those that don't apply -->
+- CDN in a Box
+- Documentation
+- Grove
+- Traffic Control Client
+- Traffic Monitor
+- Traffic Ops
+- Traffic Ops ORT
+- Traffic Portal
+- Traffic Router
+- Traffic Stats
+- Traffic Vault
+- CI tests
+- unknown
+
+## Current behavior:
+<!-- Describe how the current features are insufficient. -->
+
+## New behavior:
+<!-- Describe how the feature would improve Traffic Control -->
+
+## Minimal reproduction of the problem with instructions:
+<!--
+If you can illustrate your feature request better with an example, please
+provide the *STEPS TO REPRODUCE* and include the applicable TC version.
+If not, feel free to delete this section.
+-->
+
+## Anything else:
+<!--
+e.g. additional context, related issues, suggestions about how to approach
(feel
+free to delete this section)
+-->
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ https://apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
diff --git a/.github/ISSUE_TEMPLATE/3-improvement-request.md
b/.github/ISSUE_TEMPLATE/3-improvement-request.md
new file mode 100644
index 0000000..87c111e
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/3-improvement-request.md
@@ -0,0 +1,79 @@
+---
+name: Improvement request
+
+about: Suggest how to improve Traffic Control. Examples include usability,
performance, tech debt, etc.
+
+labels: improvement
+
+---
+
+<!--
+************ STOP!! ************
+If this issue identifies a security vulnerability, DO NOT submit it! Instead,
contact
+the Apache Traffic Control Security Team at [email protected]
and follow the
+guidelines at https://www.apache.org/security/ regarding vulnerability
disclosure.
+
+- For *SUPPORT QUESTIONS*, use the Traffic Control slack
(https://s.apache.org/atc-slack)
+or Traffic Control mailing lists
(https://trafficcontrol.apache.org/mailing_lists).
+- Before submitting, please **SEARCH GITHUB** for a similar issue or PR.
+-->
+
+## I'm submitting a ...
+<!-- delete all those that don't apply -->
+<!--- security vulnerability (STOP!! - see above)-->
+- improvement request (usability, performance, tech debt, etc.)
+- other <!--(Please do not submit support requests here - see above)-->
+
+## Traffic Control components affected ...
+<!-- delete all those that don't apply -->
+- CDN in a Box
+- Documentation
+- Grove
+- Traffic Control Client
+- Traffic Monitor
+- Traffic Ops
+- Traffic Ops ORT
+- Traffic Portal
+- Traffic Router
+- Traffic Stats
+- Traffic Vault
+- CI tests
+- unknown
+
+## Current behavior:
+<!-- Describe how the current features are insufficient. -->
+
+## New behavior:
+<!-- Describe how the feature would improve Traffic Control -->
+
+## Minimal reproduction of the problem with instructions:
+<!--
+If you can illustrate your feature request better with an example, please
+provide the *STEPS TO REPRODUCE* and include the applicable TC version.
+If not, feel free to delete this section.
+-->
+
+## Anything else:
+<!--
+e.g. additional context, related issues, suggestions about how to approach
(feel
+free to delete this section)
+-->
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ https://apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
diff --git a/.github/ISSUE_TEMPLATE/config.yml
b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 0000000..e78989e
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,21 @@
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# https://apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+---
+blank_issues_enabled: false
+contact_links:
+ - name: Discuss the project
+ url: http://trafficcontrol.apache.org/mailing_lists
+ about: Reach out to one of the Traffic Control mailing lists for
discussion.
+ - name: Support questions
+ url: https://s.apache.org/atc-slack
+ about: Visit us on Slack to ask a question.
diff --git a/.github/workflows/ciab.yaml b/.github/workflows/ciab.yaml
index cf3589a..465f104 100644
--- a/.github/workflows/ciab.yaml
+++ b/.github/workflows/ciab.yaml
@@ -27,6 +27,7 @@ on:
- 'blueprints/**'
- 'docs/**'
- 'experimental/**'
+ - '.github/ISSUE_TEMPLATE/config.yml'
- 'licenses/**'
- 'misc/**'
- 'NOTICE'
@@ -41,6 +42,7 @@ on:
- 'blueprints/**'
- 'docs/**'
- 'experimental/**'
+ - '.github/ISSUE_TEMPLATE/config.yml'
- 'licenses/**'
- 'misc/**'
- 'NOTICE'
