You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@trafficcontrol.apache.org by GitBox <gi...@apache.org> on 2021/07/23 18:22:23 UTC
[GitHub] [trafficcontrol] zrhoffman opened a new pull request #6055: Shorter and clarify PR and Issue templates
zrhoffman opened a new pull request #6055:
URL: https://github.com/apache/trafficcontrol/pull/6055
<!--
************ STOP!! ************
If this Pull Request is intended to fix a security vulnerability, DO NOT submit it! Instead, contact
the Apache Traffic Control Security Team at security@trafficcontrol.apache.org and follow the
guidelines at https://apache.org/security regarding vulnerability disclosure.
-->
## What does this PR (Pull Request) do?
- [x] This PR is not related to any Issue
<!-- Or you can say
- [x] This PR is not related to any Issue
A description of your PR goes here ↓ -->
This PR shortens the PR template and the Issue templates to make them easier to use. See the [mailing list thread](https://lists.apache.org/list.html?dev@trafficcontrol.apache.org) for details.
## Which Traffic Control components are affected by this PR?
<!-- Please delete all components from this list that are NOT affected by this Pull Request.
Feel free to add the name of a tool or script that is affected but not on the list.
-->
- GitHub Templates
## What is the best way to verify this PR?
<!-- Please include here ALL the steps necessary to test your Pull Request.
If your PR includes tests (and most should), provide the steps needed to run the tests.
If not, please provide step-by-step instructions to test the PR manually and explain why your PR does not need tests. -->
* Visit https://github.com/zrhoffman/trafficcontrol/issues/new/choose and view the *Write* and *Preview* sections for *Bug report*, *Feature request*, and *Improvement request*
* Visit https://github.com/zrhoffman/trafficcontrol/compare/master...zrhoffman:my-branch and view the *Write* and *Preview* sections after clicking the first *Create pull request* button (but not the second)
## The following criteria are ALL met by this PR
<!-- Check each box to signify that the associated statement is true. For example:
- [x] ← Correct!
- [ x] ← Wrong
- [] ← Wrong
- [*] ← Wrong -->
- [x] GitHub templates change only, no tests needed
- [x] GitHub templates change only, no additional documentation needed
- [ ] This PR includes a CHANGELOG.md entry <!-- A fix for a bug from an ATC release, an improvement, or a new feature should include a changelog entry. -->
- [x] This PR **DOES NOT FIX A SERIOUS SECURITY VULNERABILITY** (see [the Apache Software Foundation's security guidelines](https://apache.org/security) for details)
<!--
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
http://www.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.
-->
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request #6055: Shorten and clarify PR and Issue templates
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #6055:
URL: https://github.com/apache/trafficcontrol/pull/6055#discussion_r679548055
##########
File path: .github/ISSUE_TEMPLATE/2-feature-request.md
##########
@@ -1,79 +1,62 @@
---
+# 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
+#
+# http://www.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.
+#
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 security@trafficcontrol.apache.org and follow the
-guidelines at https://www.apache.org/security/ regarding vulnerability disclosure.
+guidelines at https://apache.org/security regarding vulnerability disclosure.
- For *SUPPORT QUESTIONS*, use the #traffic-control channel on the ASF slack (https://s.apache.org/slack-invite)
-or Traffic Control mailing lists (https://trafficcontrol.apache.org/mailing_lists).
-- Before submitting, please **SEARCH GITHUB** for a similar issue or PR.
+or the Traffic Control Users mailing list (send an email to users-subscribe@trafficcontrol.apache.org to subscribe).
+- Before submitting, please **SEARCH GITHUB** for a similar issue or PR
+ * https://github.com/apache/trafficcontrol/issues
+ * https://github.com/apache/trafficcontrol/pulls
-->
## 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)-->
+<!-- Do not submit a security vulnerability here - see above security vulnerability info -->
+- [x] new feature / enhancement request
+<!-- 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
+- Traffic Control Cache Config (T3C)
+- Traffic Control Client <!-- Please specify which (Python, Go, or Java) -->
+- Traffic Monitor
+- Traffic Ops
+- Traffic Portal
+- Traffic Router
+- Traffic Stats
+- Grove
+- Documentation
+- CDN in a Box
+- Automation (GitHub Actions, Ansible Roles)
+- unknown
## Current behavior:
Review comment:
Renamed to *new feature* in 05fa1a7434
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request #6055: Shorten and clarify PR and Issue templates
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #6055:
URL: https://github.com/apache/trafficcontrol/pull/6055#discussion_r675852778
##########
File path: .github/ISSUE_TEMPLATE/1-bug-report.md
##########
@@ -1,78 +1,66 @@
---
+# 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
+#
+# http://www.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.
+#
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 Traffic Control Security Team at security@trafficcontrol.apache.org and follow the
-guidelines at https://www.apache.org/security/ regarding vulnerability disclosure.
+guidelines at https://apache.org/security regarding vulnerability disclosure.
- For *SUPPORT QUESTIONS*, use the #traffic-control channel on the ASF slack (https://s.apache.org/slack-invite)
-or Traffic Control mailing lists (https://trafficcontrol.apache.org/mailing_lists).
-- Before submitting, please **SEARCH GITHUB** for a similar issue or PR.
+or the Traffic Control Users mailing list (send an email to users-subscribe@trafficcontrol.apache.org to subscribe).
+- Before submitting, please **SEARCH GITHUB** for a similar issue or PR
+ * https://github.com/apache/trafficcontrol/issues
+ * https://github.com/apache/trafficcontrol/pulls
-->
## I'm submitting a ...
-<!-- delete all those that don't apply -->
-<!--- security vulnerability (STOP!! - see above)-->
-- bug report
-- other <!--(Please do not submit support requests here - see above)-->
+<!-- Do not submit a security vulnerability here - see above security vulnerability info -->
+- [x] bug report
+<!--Please do not submit support requests here - see above-->
Review comment:
Space added in 1bd84550bd
##########
File path: .github/ISSUE_TEMPLATE/2-feature-request.md
##########
@@ -1,79 +1,62 @@
---
+# 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
+#
+# http://www.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.
+#
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 security@trafficcontrol.apache.org and follow the
-guidelines at https://www.apache.org/security/ regarding vulnerability disclosure.
+guidelines at https://apache.org/security regarding vulnerability disclosure.
- For *SUPPORT QUESTIONS*, use the #traffic-control channel on the ASF slack (https://s.apache.org/slack-invite)
-or Traffic Control mailing lists (https://trafficcontrol.apache.org/mailing_lists).
-- Before submitting, please **SEARCH GITHUB** for a similar issue or PR.
+or the Traffic Control Users mailing list (send an email to users-subscribe@trafficcontrol.apache.org to subscribe).
+- Before submitting, please **SEARCH GITHUB** for a similar issue or PR
+ * https://github.com/apache/trafficcontrol/issues
+ * https://github.com/apache/trafficcontrol/pulls
-->
## 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)-->
+<!-- Do not submit a security vulnerability here - see above security vulnerability info -->
+- [x] new feature / enhancement request
+<!--Please do not submit support requests here - see above-->
Review comment:
Space added in 1bd84550bd
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] mitchell852 commented on a change in pull request #6055: Shorten and clarify PR and Issue templates
Posted by GitBox <gi...@apache.org>.
mitchell852 commented on a change in pull request #6055:
URL: https://github.com/apache/trafficcontrol/pull/6055#discussion_r678411308
##########
File path: .github/ISSUE_TEMPLATE/1-bug-report.md
##########
@@ -1,78 +1,68 @@
---
+# 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
+#
+# http://www.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.
+#
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 Traffic Control Security Team at security@trafficcontrol.apache.org and follow the
-guidelines at https://www.apache.org/security/ regarding vulnerability disclosure.
+guidelines at https://apache.org/security regarding vulnerability disclosure.
- For *SUPPORT QUESTIONS*, use the #traffic-control channel on the ASF slack (https://s.apache.org/slack-invite)
-or Traffic Control mailing lists (https://trafficcontrol.apache.org/mailing_lists).
-- Before submitting, please **SEARCH GITHUB** for a similar issue or PR.
+or the Traffic Control Users mailing list (send an email to users-subscribe@trafficcontrol.apache.org to subscribe).
+- Before submitting, please **SEARCH GITHUB** for a similar issue or PR
+ * https://github.com/apache/trafficcontrol/issues
+ * https://github.com/apache/trafficcontrol/pulls
-->
## I'm submitting a ...
-<!-- delete all those that don't apply -->
-<!--- security vulnerability (STOP!! - see above)-->
-- bug report
-- other <!--(Please do not submit support requests here - see above)-->
+<!-- Do not submit a security vulnerability here - see above security vulnerability info -->
+- [x] bug report
+<!-- 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
+- Traffic Control Cache Config (T3C)
Review comment:
how about
```
Traffic Control Cache Config (T3C formerly ORT)
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] mitchell852 commented on a change in pull request #6055: Shorten and clarify PR and Issue templates
Posted by GitBox <gi...@apache.org>.
mitchell852 commented on a change in pull request #6055:
URL: https://github.com/apache/trafficcontrol/pull/6055#discussion_r684402485
##########
File path: .github/ISSUE_TEMPLATE/1-bug-report.md
##########
@@ -1,78 +1,68 @@
---
+# 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
+#
+# http://www.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.
+#
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 Traffic Control Security Team at security@trafficcontrol.apache.org and follow the
-guidelines at https://www.apache.org/security/ regarding vulnerability disclosure.
+guidelines at https://apache.org/security regarding vulnerability disclosure.
- For *SUPPORT QUESTIONS*, use the #traffic-control channel on the ASF slack (https://s.apache.org/slack-invite)
-or Traffic Control mailing lists (https://trafficcontrol.apache.org/mailing_lists).
-- Before submitting, please **SEARCH GITHUB** for a similar issue or PR.
+or the Traffic Control Users mailing list (send an email to users-subscribe@trafficcontrol.apache.org to subscribe).
+- Before submitting, please **SEARCH GITHUB** for a similar issue or PR
+ * https://github.com/apache/trafficcontrol/issues
+ * https://github.com/apache/trafficcontrol/pulls
-->
## I'm submitting a ...
Review comment:
yeah, i was just thinking it would be nice what their opinion was.
```
- minor
- medium
- major
- critical
- not sure
```
but i'm fine leaving that to project maintainers.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request #6055: Shorten and clarify PR and Issue templates
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #6055:
URL: https://github.com/apache/trafficcontrol/pull/6055#discussion_r678508547
##########
File path: .github/ISSUE_TEMPLATE/2-feature-request.md
##########
@@ -1,79 +1,62 @@
---
+# 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
+#
+# http://www.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.
+#
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 security@trafficcontrol.apache.org and follow the
-guidelines at https://www.apache.org/security/ regarding vulnerability disclosure.
+guidelines at https://apache.org/security regarding vulnerability disclosure.
- For *SUPPORT QUESTIONS*, use the #traffic-control channel on the ASF slack (https://s.apache.org/slack-invite)
-or Traffic Control mailing lists (https://trafficcontrol.apache.org/mailing_lists).
-- Before submitting, please **SEARCH GITHUB** for a similar issue or PR.
+or the Traffic Control Users mailing list (send an email to users-subscribe@trafficcontrol.apache.org to subscribe).
+- Before submitting, please **SEARCH GITHUB** for a similar issue or PR
+ * https://github.com/apache/trafficcontrol/issues
+ * https://github.com/apache/trafficcontrol/pulls
-->
## 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)-->
+<!-- Do not submit a security vulnerability here - see above security vulnerability info -->
+- [x] new feature / enhancement request
+<!-- 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
+- Traffic Control Cache Config (T3C)
+- Traffic Control Client <!-- Please specify which (Python, Go, or Java) -->
+- Traffic Monitor
+- Traffic Ops
+- Traffic Portal
+- Traffic Router
+- Traffic Stats
+- Grove
+- Documentation
+- CDN in a Box
+- Automation (GitHub Actions, Ansible Roles)
+- unknown
## Current behavior:
Review comment:
The lines between those are blurry, IMO. For similar reasons I'm also not sure we need both the `enhancement` and `improvement` labels, but that's a separate discussion.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] mitchell852 commented on pull request #6055: Shorten and clarify PR and Issue templates
Posted by GitBox <gi...@apache.org>.
mitchell852 commented on pull request #6055:
URL: https://github.com/apache/trafficcontrol/pull/6055#issuecomment-888400646
nit:
```
## I'm submitting a ...
<!-- Do not submit a security vulnerability here - see above security vulnerability info -->
- [x] bug report
<!-- Please do not submit support requests here - see above-->
```
want to move the 2 comments to the top like this?
## I'm submitting a ...
<!-- Do not submit a security vulnerability here - see above security vulnerability info -->
<!-- Please do not submit support requests here - see above-->
- [x] bug report
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request #6055: Shorten and clarify PR and Issue templates
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #6055:
URL: https://github.com/apache/trafficcontrol/pull/6055#discussion_r675857475
##########
File path: PULL_REQUEST_TEMPLATE.md
##########
@@ -1,104 +1,59 @@
<!--
************ STOP!! ************
If this Pull Request is intended to fix a security vulnerability, DO NOT submit it! Instead, contact
-the Apache Software Foundation Security Team at security@trafficcontrol.apache.org and follow the
-guidelines at https://www.apache.org/security/ regarding vulnerability disclosure.
+the Apache Traffic Control Security Team at security@trafficcontrol.apache.org and follow the
+guidelines at https://apache.org/security regarding vulnerability disclosure.
-->
## What does this PR (Pull Request) do?
-<!-- Explain the changes you made here. If this fixes an Issue, identify it by
-replacing the text in the checkbox item with the Issue number e.g.
+- [ ] This PR fixes #REPLACE_ME
Review comment:
does
```markdown
closes: #ISSUE
```
work for linking an issue? I'm not sure the <kbd>:</kbd> is allowed.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] mitchell852 edited a comment on pull request #6055: Shorten and clarify PR and Issue templates
Posted by GitBox <gi...@apache.org>.
mitchell852 edited a comment on pull request #6055:
URL: https://github.com/apache/trafficcontrol/pull/6055#issuecomment-888400646
nit:
```
## I'm submitting a ...
<!-- Do not submit a security vulnerability here - see above security vulnerability info -->
- [x] bug report
<!-- Please do not submit support requests here - see above-->
```
want to move the 2 comments to the top like this?
```
## I'm submitting a ...
<!-- Do not submit a security vulnerability here - see above security vulnerability info -->
<!-- Please do not submit support requests here - see above-->
- [x] bug report
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request #6055: Shorten and clarify PR and Issue templates
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #6055:
URL: https://github.com/apache/trafficcontrol/pull/6055#discussion_r679538530
##########
File path: .github/ISSUE_TEMPLATE/2-feature-request.md
##########
@@ -1,79 +1,62 @@
---
+# 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
+#
+# http://www.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.
+#
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 security@trafficcontrol.apache.org and follow the
-guidelines at https://www.apache.org/security/ regarding vulnerability disclosure.
+guidelines at https://apache.org/security regarding vulnerability disclosure.
- For *SUPPORT QUESTIONS*, use the #traffic-control channel on the ASF slack (https://s.apache.org/slack-invite)
-or Traffic Control mailing lists (https://trafficcontrol.apache.org/mailing_lists).
-- Before submitting, please **SEARCH GITHUB** for a similar issue or PR.
+or the Traffic Control Users mailing list (send an email to users-subscribe@trafficcontrol.apache.org to subscribe).
+- Before submitting, please **SEARCH GITHUB** for a similar issue or PR
+ * https://github.com/apache/trafficcontrol/issues
+ * https://github.com/apache/trafficcontrol/pulls
-->
## 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)-->
+<!-- Do not submit a security vulnerability here - see above security vulnerability info -->
+- [x] new feature / enhancement request
+<!-- 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
+- Traffic Control Cache Config (T3C)
+- Traffic Control Client <!-- Please specify which (Python, Go, or Java) -->
+- Traffic Monitor
+- Traffic Ops
+- Traffic Portal
+- Traffic Router
+- Traffic Stats
+- Grove
+- Documentation
+- CDN in a Box
+- Automation (GitHub Actions, Ansible Roles)
+- unknown
## Current behavior:
Review comment:
that would certainly help.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] rawlinp commented on a change in pull request #6055: Shorten and clarify PR and Issue templates
Posted by GitBox <gi...@apache.org>.
rawlinp commented on a change in pull request #6055:
URL: https://github.com/apache/trafficcontrol/pull/6055#discussion_r678451448
##########
File path: .github/ISSUE_TEMPLATE/2-feature-request.md
##########
@@ -1,79 +1,62 @@
---
+# 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
+#
+# http://www.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.
+#
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 security@trafficcontrol.apache.org and follow the
-guidelines at https://www.apache.org/security/ regarding vulnerability disclosure.
+guidelines at https://apache.org/security regarding vulnerability disclosure.
- For *SUPPORT QUESTIONS*, use the #traffic-control channel on the ASF slack (https://s.apache.org/slack-invite)
-or Traffic Control mailing lists (https://trafficcontrol.apache.org/mailing_lists).
-- Before submitting, please **SEARCH GITHUB** for a similar issue or PR.
+or the Traffic Control Users mailing list (send an email to users-subscribe@trafficcontrol.apache.org to subscribe).
+- Before submitting, please **SEARCH GITHUB** for a similar issue or PR
+ * https://github.com/apache/trafficcontrol/issues
+ * https://github.com/apache/trafficcontrol/pulls
-->
## 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)-->
+<!-- Do not submit a security vulnerability here - see above security vulnerability info -->
+- [x] new feature / enhancement request
+<!-- 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
+- Traffic Control Cache Config (T3C)
+- Traffic Control Client <!-- Please specify which (Python, Go, or Java) -->
+- Traffic Monitor
+- Traffic Ops
+- Traffic Portal
+- Traffic Router
+- Traffic Stats
+- Grove
+- Documentation
+- CDN in a Box
+- Automation (GitHub Actions, Ansible Roles)
+- unknown
## Current behavior:
Review comment:
I guess we should probably do something similar for the improvement request and bug report?
Now that I type that out, do we even need to differentiate between improvement and feature requests? Those two have always been kind of confusing. Maybe we should get rid of one altogether?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] zrhoffman commented on pull request #6055: Shorten and clarify PR and Issue templates
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on pull request #6055:
URL: https://github.com/apache/trafficcontrol/pull/6055#issuecomment-888727033
> want to move the 2 comments to the top like this? same with other issue templates.
Moved in edfb4774ca.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] rawlinp commented on a change in pull request #6055: Shorten and clarify PR and Issue templates
Posted by GitBox <gi...@apache.org>.
rawlinp commented on a change in pull request #6055:
URL: https://github.com/apache/trafficcontrol/pull/6055#discussion_r675873486
##########
File path: PULL_REQUEST_TEMPLATE.md
##########
@@ -1,104 +1,59 @@
<!--
************ STOP!! ************
If this Pull Request is intended to fix a security vulnerability, DO NOT submit it! Instead, contact
-the Apache Software Foundation Security Team at security@trafficcontrol.apache.org and follow the
-guidelines at https://www.apache.org/security/ regarding vulnerability disclosure.
+the Apache Traffic Control Security Team at security@trafficcontrol.apache.org and follow the
+guidelines at https://apache.org/security regarding vulnerability disclosure.
-->
## What does this PR (Pull Request) do?
-<!-- Explain the changes you made here. If this fixes an Issue, identify it by
-replacing the text in the checkbox item with the Issue number e.g.
+- [ ] This PR fixes #REPLACE_ME
+<!-- Or you can say
+- [x] This PR is not related to any Issue
-- [x] This PR fixes #9001 OR is not related to any Issue
-
-^ This will automatically close Issue number 9001 when the Pull Request is
-merged (The '#' is important).
-
-Be sure you check the box properly, see the "The following criteria are ALL
-met by this PR" section for details.
--->
-
-- [ ] This PR fixes #REPLACE_ME OR is not related to any Issue <!-- You can check for an issue here: https://github.com/apache/trafficcontrol/issues -->
+A description of your PR goes here ↓ -->
## Which Traffic Control components are affected by this PR?
-<!-- Please delete all components from this list that are NOT affected by this
-Pull Request. Also, feel free to add the name of a tool or script that is
-affected but not on the list.
-
-Additionally, if this Pull Request does NOT affect documentation, please
-explain why documentation is not required. -->
-
-- CDN in a Box
-- Documentation
-- Grove
-- Traffic Control Client <!-- Please specify which; e.g. 'Python', 'Go', 'Java' -->
+<!-- Please delete all components from this list that are NOT affected by this Pull Request.
+Feel free to add the name of a tool or script that is affected but not on the list.
+-->
+- Documentation <!-- If this Pull Request does NOT affect documentation, please explain why. -->
+- Traffic Control Cache Config (T3C)
+- Traffic Control Client <!-- Please specify which (Python, Go, or Java) -->
- Traffic Monitor
- Traffic Ops
-- Traffic Ops ORT
- Traffic Portal
- Traffic Router
- Traffic Stats
-- Traffic Vault
-- CI tests
+- Grove
+- CDN in a Box
+- Automation <!-- Please specify which (GitHub Actions, Docker images, Ansible Roles, etc.) -->
+- unknown
## What is the best way to verify this PR?
-<!-- Please include here ALL the steps necessary to test your Pull Request. If
-it includes tests (and most should), outline here the steps needed to run the
-tests. If not, lay out the manual testing procedure and please explain why
-tests are unnecessary for this Pull Request. -->
+<!-- Please include here ALL the steps necessary to test your Pull Request.
+If your PR includes tests (and most should), provide the steps needed to run the tests.
+If not, please provide step-by-step instructions to test the PR manually and explain why your PR does not need tests. -->
-## If this is a bug fix, what versions of Traffic Control are affected?
-<!-- If this PR fixes a bug, please list here all of the affected versions - to
-the best of your knowledge. It's also pretty helpful to include a commit hash
-of where 'master' is at the time this PR is opened (if it affects master),
-because what 'master' means will change over time. For example, if this PR
-fixes a bug that's present in master (at commit hash '1df853c8'), in v4.0.0,
-and in the current 4.0.1 Release candidate (e.g. RC1), then this list would
-look like:
-- master (1df853c8)
-- 4.0.0
-- 4.0.1 (RC1)
-
-If you don't know what other versions might have this bug, AND don't know how
-to find the commit hash of 'master', then feel free to leave this section
-blank (or, preferably, delete it entirely).
+## If this is a bugfix, which Traffic Control versions contained the bug?
+<!-- Delete this section if the PR is not a bugfix, or if the bug is only in the master branch.
+Examples:
+- 5.1.2
+- 5.1.3 (RC1)
-->
## The following criteria are ALL met by this PR
-<!-- Check the boxes to signify that the associated statement is true. To
-"check a box", replace the space inside of the square brackets with an 'x'.
-e.g.
-
-- [ x] <- Wrong
-- [x ] <- Wrong
-- [] <- Wrong
-- [*] <- Wrong
-- [x] <- Correct!
-
--->
-
-- [ ] This PR includes tests OR I have explained why tests are unnecessary
-- [ ] This PR includes documentation OR I have explained why documentation is unnecessary
-- [ ] This PR includes an update to CHANGELOG.md OR such an update is not necessary
-- [ ] This PR includes any and all required license headers
-- [ ] This PR **DOES NOT FIX A SERIOUS SECURITY VULNERABILITY** (see [the Apache Software Foundation's security guidelines](https://www.apache.org/security/) for details)
-
-
-## Additional Information
-<!-- If you would like to include any additional information on the PR for
-potential reviewers please put it here.
-
-Some examples of this would be:
-
-- Before and after screenshots/gifs of the Traffic Portal if it is affected
-- Links to other dependent Pull Requests
-- References to relevant context (e.g. new/updates to dependent libraries,
-mailing list records, blueprints)
-
-Feel free to leave this section blank (or, preferably, delete it entirely).
--->
+<!-- Check each box to signify that the associated statement is true. For example:
Review comment:
No, I think the inline instructions are fine, I was just talking about the "how do I check a checkbox" instructions.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request #6055: Shorten and clarify PR and Issue templates
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #6055:
URL: https://github.com/apache/trafficcontrol/pull/6055#discussion_r675863691
##########
File path: PULL_REQUEST_TEMPLATE.md
##########
@@ -1,104 +1,59 @@
<!--
************ STOP!! ************
If this Pull Request is intended to fix a security vulnerability, DO NOT submit it! Instead, contact
-the Apache Software Foundation Security Team at security@trafficcontrol.apache.org and follow the
-guidelines at https://www.apache.org/security/ regarding vulnerability disclosure.
+the Apache Traffic Control Security Team at security@trafficcontrol.apache.org and follow the
+guidelines at https://apache.org/security regarding vulnerability disclosure.
-->
## What does this PR (Pull Request) do?
-<!-- Explain the changes you made here. If this fixes an Issue, identify it by
-replacing the text in the checkbox item with the Issue number e.g.
+- [ ] This PR fixes #REPLACE_ME
Review comment:
Fancy. Confirmed it works, that's an undocumented feature.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] rawlinp commented on a change in pull request #6055: Shorten and clarify PR and Issue templates
Posted by GitBox <gi...@apache.org>.
rawlinp commented on a change in pull request #6055:
URL: https://github.com/apache/trafficcontrol/pull/6055#discussion_r684407295
##########
File path: .github/ISSUE_TEMPLATE/1-bug-report.md
##########
@@ -1,78 +1,68 @@
---
+# 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
+#
+# http://www.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.
+#
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 Traffic Control Security Team at security@trafficcontrol.apache.org and follow the
-guidelines at https://www.apache.org/security/ regarding vulnerability disclosure.
+guidelines at https://apache.org/security regarding vulnerability disclosure.
- For *SUPPORT QUESTIONS*, use the #traffic-control channel on the ASF slack (https://s.apache.org/slack-invite)
-or Traffic Control mailing lists (https://trafficcontrol.apache.org/mailing_lists).
-- Before submitting, please **SEARCH GITHUB** for a similar issue or PR.
+or the Traffic Control Users mailing list (send an email to users-subscribe@trafficcontrol.apache.org to subscribe).
+- Before submitting, please **SEARCH GITHUB** for a similar issue or PR
+ * https://github.com/apache/trafficcontrol/issues
+ * https://github.com/apache/trafficcontrol/pulls
-->
## I'm submitting a ...
Review comment:
Yeah, severity should really be relative to the existing severities that have been assigned to other issues by the project maintainers. Otherwise, severities will be all over the place. One person's major is another person's minor.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request #6055: Shorten and clarify PR and Issue templates
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #6055:
URL: https://github.com/apache/trafficcontrol/pull/6055#discussion_r684399157
##########
File path: .github/ISSUE_TEMPLATE/1-bug-report.md
##########
@@ -1,78 +1,68 @@
---
+# 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
+#
+# http://www.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.
+#
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 Traffic Control Security Team at security@trafficcontrol.apache.org and follow the
-guidelines at https://www.apache.org/security/ regarding vulnerability disclosure.
+guidelines at https://apache.org/security regarding vulnerability disclosure.
- For *SUPPORT QUESTIONS*, use the #traffic-control channel on the ASF slack (https://s.apache.org/slack-invite)
-or Traffic Control mailing lists (https://trafficcontrol.apache.org/mailing_lists).
-- Before submitting, please **SEARCH GITHUB** for a similar issue or PR.
+or the Traffic Control Users mailing list (send an email to users-subscribe@trafficcontrol.apache.org to subscribe).
+- Before submitting, please **SEARCH GITHUB** for a similar issue or PR
+ * https://github.com/apache/trafficcontrol/issues
+ * https://github.com/apache/trafficcontrol/pulls
-->
## I'm submitting a ...
Review comment:
Issue triage is something for maintainers of the project to handle, users shouldn't have to answer an additional question.
Changed *I'm submitting a ...* to a *Bug report* title in 6f12ee4525.
##########
File path: .github/ISSUE_TEMPLATE/3-improvement-request.md
##########
@@ -1,79 +1,62 @@
---
+# 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
+#
+# http://www.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.
+#
name: Improvement request
-
-about: Suggest how to improve Traffic Control. Examples include usability, performance, tech debt, etc.
-
+about: Suggest how to improve an existing feature of Traffic Control (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 security@trafficcontrol.apache.org and follow the
-guidelines at https://www.apache.org/security/ regarding vulnerability disclosure.
+guidelines at https://apache.org/security regarding vulnerability disclosure.
- For *SUPPORT QUESTIONS*, use the #traffic-control channel on the ASF slack (https://s.apache.org/slack-invite)
-or Traffic Control mailing lists (https://trafficcontrol.apache.org/mailing_lists).
-- Before submitting, please **SEARCH GITHUB** for a similar issue or PR.
+or the Traffic Control Users mailing list (send an email to users-subscribe@trafficcontrol.apache.org to subscribe).
+- Before submitting, please **SEARCH GITHUB** for a similar issue or PR
+ * https://github.com/apache/trafficcontrol/issues
+ * https://github.com/apache/trafficcontrol/pulls
-->
## I'm submitting a ...
Review comment:
We can categorize it after the Issue is submitted, users shouldn't have to answer an additional question.
Changed *I'm submitting a ...* to a *Improvement request (usability, [performance](https://github.com/apache/trafficcontrol/issues?q=is:open+is:issue+label:performance+sort:updated-desc), [tech debt](https://github.com/apache/trafficcontrol/issues?q=is:open+is:issue+label:"tech+debt"+sort:updated-desc), etc.)* title in 6f12ee4525.
##########
File path: .github/ISSUE_TEMPLATE/2-feature-request.md
##########
@@ -1,79 +1,58 @@
---
+# 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
+#
+# http://www.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.
+#
name: Feature request
-
about: Suggest how to improve Traffic Control with something new
-
-labels: enhancement
-
+labels: new feature
---
-
<!--
************ STOP!! ************
If this issue identifies a security vulnerability, DO NOT submit it! Instead, contact
the Apache Traffic Control Security Team at security@trafficcontrol.apache.org and follow the
-guidelines at https://www.apache.org/security/ regarding vulnerability disclosure.
+guidelines at https://apache.org/security regarding vulnerability disclosure.
- For *SUPPORT QUESTIONS*, use the #traffic-control channel on the ASF slack (https://s.apache.org/slack-invite)
-or Traffic Control mailing lists (https://trafficcontrol.apache.org/mailing_lists).
-- Before submitting, please **SEARCH GITHUB** for a similar issue or PR.
+or the Traffic Control Users mailing list (send an email to users-subscribe@trafficcontrol.apache.org to subscribe).
+- Before submitting, please **SEARCH GITHUB** for a similar issue or PR
+ * https://github.com/apache/trafficcontrol/issues
+ * https://github.com/apache/trafficcontrol/pulls
-->
## I'm submitting a ...
Review comment:
Changed *I'm submitting a ...* to a *Feature request* title in 6f12ee4525.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] mitchell852 merged pull request #6055: Shorten and clarify PR and Issue templates
Posted by GitBox <gi...@apache.org>.
mitchell852 merged pull request #6055:
URL: https://github.com/apache/trafficcontrol/pull/6055
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] mitchell852 commented on a change in pull request #6055: Shorten and clarify PR and Issue templates
Posted by GitBox <gi...@apache.org>.
mitchell852 commented on a change in pull request #6055:
URL: https://github.com/apache/trafficcontrol/pull/6055#discussion_r684385622
##########
File path: .github/ISSUE_TEMPLATE/1-bug-report.md
##########
@@ -1,78 +1,68 @@
---
+# 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
+#
+# http://www.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.
+#
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 Traffic Control Security Team at security@trafficcontrol.apache.org and follow the
-guidelines at https://www.apache.org/security/ regarding vulnerability disclosure.
+guidelines at https://apache.org/security regarding vulnerability disclosure.
- For *SUPPORT QUESTIONS*, use the #traffic-control channel on the ASF slack (https://s.apache.org/slack-invite)
-or Traffic Control mailing lists (https://trafficcontrol.apache.org/mailing_lists).
-- Before submitting, please **SEARCH GITHUB** for a similar issue or PR.
+or the Traffic Control Users mailing list (send an email to users-subscribe@trafficcontrol.apache.org to subscribe).
+- Before submitting, please **SEARCH GITHUB** for a similar issue or PR
+ * https://github.com/apache/trafficcontrol/issues
+ * https://github.com/apache/trafficcontrol/pulls
-->
## I'm submitting a ...
Review comment:
i'm wondering if this should just say "I'm submitting a bug report which i consider to have a severity of:"
```
- minor
- medium
- major
- critical
```
would be nice to get some guidance on what level of severity they consider the bug to be...
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request #6055: Shorten and clarify PR and Issue templates
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #6055:
URL: https://github.com/apache/trafficcontrol/pull/6055#discussion_r675871091
##########
File path: PULL_REQUEST_TEMPLATE.md
##########
@@ -1,104 +1,59 @@
<!--
************ STOP!! ************
If this Pull Request is intended to fix a security vulnerability, DO NOT submit it! Instead, contact
-the Apache Software Foundation Security Team at security@trafficcontrol.apache.org and follow the
-guidelines at https://www.apache.org/security/ regarding vulnerability disclosure.
+the Apache Traffic Control Security Team at security@trafficcontrol.apache.org and follow the
+guidelines at https://apache.org/security regarding vulnerability disclosure.
-->
## What does this PR (Pull Request) do?
-<!-- Explain the changes you made here. If this fixes an Issue, identify it by
-replacing the text in the checkbox item with the Issue number e.g.
+- [ ] This PR fixes #REPLACE_ME
+<!-- Or you can say
+- [x] This PR is not related to any Issue
-- [x] This PR fixes #9001 OR is not related to any Issue
-
-^ This will automatically close Issue number 9001 when the Pull Request is
-merged (The '#' is important).
-
-Be sure you check the box properly, see the "The following criteria are ALL
-met by this PR" section for details.
--->
-
-- [ ] This PR fixes #REPLACE_ME OR is not related to any Issue <!-- You can check for an issue here: https://github.com/apache/trafficcontrol/issues -->
+A description of your PR goes here ↓ -->
## Which Traffic Control components are affected by this PR?
-<!-- Please delete all components from this list that are NOT affected by this
-Pull Request. Also, feel free to add the name of a tool or script that is
-affected but not on the list.
-
-Additionally, if this Pull Request does NOT affect documentation, please
-explain why documentation is not required. -->
-
-- CDN in a Box
-- Documentation
-- Grove
-- Traffic Control Client <!-- Please specify which; e.g. 'Python', 'Go', 'Java' -->
+<!-- Please delete all components from this list that are NOT affected by this Pull Request.
+Feel free to add the name of a tool or script that is affected but not on the list.
+-->
+- Documentation <!-- If this Pull Request does NOT affect documentation, please explain why. -->
+- Traffic Control Cache Config (T3C)
+- Traffic Control Client <!-- Please specify which (Python, Go, or Java) -->
- Traffic Monitor
- Traffic Ops
-- Traffic Ops ORT
- Traffic Portal
- Traffic Router
- Traffic Stats
-- Traffic Vault
-- CI tests
+- Grove
+- CDN in a Box
+- Automation <!-- Please specify which (GitHub Actions, Docker images, Ansible Roles, etc.) -->
+- unknown
## What is the best way to verify this PR?
-<!-- Please include here ALL the steps necessary to test your Pull Request. If
-it includes tests (and most should), outline here the steps needed to run the
-tests. If not, lay out the manual testing procedure and please explain why
-tests are unnecessary for this Pull Request. -->
+<!-- Please include here ALL the steps necessary to test your Pull Request.
+If your PR includes tests (and most should), provide the steps needed to run the tests.
+If not, please provide step-by-step instructions to test the PR manually and explain why your PR does not need tests. -->
-## If this is a bug fix, what versions of Traffic Control are affected?
-<!-- If this PR fixes a bug, please list here all of the affected versions - to
-the best of your knowledge. It's also pretty helpful to include a commit hash
-of where 'master' is at the time this PR is opened (if it affects master),
-because what 'master' means will change over time. For example, if this PR
-fixes a bug that's present in master (at commit hash '1df853c8'), in v4.0.0,
-and in the current 4.0.1 Release candidate (e.g. RC1), then this list would
-look like:
-- master (1df853c8)
-- 4.0.0
-- 4.0.1 (RC1)
-
-If you don't know what other versions might have this bug, AND don't know how
-to find the commit hash of 'master', then feel free to leave this section
-blank (or, preferably, delete it entirely).
+## If this is a bugfix, which Traffic Control versions contained the bug?
+<!-- Delete this section if the PR is not a bugfix, or if the bug is only in the master branch.
+Examples:
+- 5.1.2
+- 5.1.3 (RC1)
-->
## The following criteria are ALL met by this PR
-<!-- Check the boxes to signify that the associated statement is true. To
-"check a box", replace the space inside of the square brackets with an 'x'.
-e.g.
-
-- [ x] <- Wrong
-- [x ] <- Wrong
-- [] <- Wrong
-- [*] <- Wrong
-- [x] <- Correct!
-
--->
-
-- [ ] This PR includes tests OR I have explained why tests are unnecessary
-- [ ] This PR includes documentation OR I have explained why documentation is unnecessary
-- [ ] This PR includes an update to CHANGELOG.md OR such an update is not necessary
-- [ ] This PR includes any and all required license headers
-- [ ] This PR **DOES NOT FIX A SERIOUS SECURITY VULNERABILITY** (see [the Apache Software Foundation's security guidelines](https://www.apache.org/security/) for details)
-
-
-## Additional Information
-<!-- If you would like to include any additional information on the PR for
-potential reviewers please put it here.
-
-Some examples of this would be:
-
-- Before and after screenshots/gifs of the Traffic Portal if it is affected
-- Links to other dependent Pull Requests
-- References to relevant context (e.g. new/updates to dependent libraries,
-mailing list records, blueprints)
-
-Feel free to leave this section blank (or, preferably, delete it entirely).
--->
+<!-- Check each box to signify that the associated statement is true. For example:
Review comment:
At the very least, we should be able to remove the section-wide instructions (removed in 8a2f28cfd3). Do you think the inline instructions should be removed, also?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] rawlinp commented on a change in pull request #6055: Shorten and clarify PR and Issue templates
Posted by GitBox <gi...@apache.org>.
rawlinp commented on a change in pull request #6055:
URL: https://github.com/apache/trafficcontrol/pull/6055#discussion_r675868532
##########
File path: PULL_REQUEST_TEMPLATE.md
##########
@@ -1,104 +1,59 @@
<!--
************ STOP!! ************
If this Pull Request is intended to fix a security vulnerability, DO NOT submit it! Instead, contact
-the Apache Software Foundation Security Team at security@trafficcontrol.apache.org and follow the
-guidelines at https://www.apache.org/security/ regarding vulnerability disclosure.
+the Apache Traffic Control Security Team at security@trafficcontrol.apache.org and follow the
+guidelines at https://apache.org/security regarding vulnerability disclosure.
-->
## What does this PR (Pull Request) do?
-<!-- Explain the changes you made here. If this fixes an Issue, identify it by
-replacing the text in the checkbox item with the Issue number e.g.
+- [ ] This PR fixes #REPLACE_ME
+<!-- Or you can say
+- [x] This PR is not related to any Issue
-- [x] This PR fixes #9001 OR is not related to any Issue
-
-^ This will automatically close Issue number 9001 when the Pull Request is
-merged (The '#' is important).
-
-Be sure you check the box properly, see the "The following criteria are ALL
-met by this PR" section for details.
--->
-
-- [ ] This PR fixes #REPLACE_ME OR is not related to any Issue <!-- You can check for an issue here: https://github.com/apache/trafficcontrol/issues -->
+A description of your PR goes here ↓ -->
## Which Traffic Control components are affected by this PR?
-<!-- Please delete all components from this list that are NOT affected by this
-Pull Request. Also, feel free to add the name of a tool or script that is
-affected but not on the list.
-
-Additionally, if this Pull Request does NOT affect documentation, please
-explain why documentation is not required. -->
-
-- CDN in a Box
-- Documentation
-- Grove
-- Traffic Control Client <!-- Please specify which; e.g. 'Python', 'Go', 'Java' -->
+<!-- Please delete all components from this list that are NOT affected by this Pull Request.
+Feel free to add the name of a tool or script that is affected but not on the list.
+-->
+- Documentation <!-- If this Pull Request does NOT affect documentation, please explain why. -->
+- Traffic Control Cache Config (T3C)
+- Traffic Control Client <!-- Please specify which (Python, Go, or Java) -->
- Traffic Monitor
- Traffic Ops
-- Traffic Ops ORT
- Traffic Portal
- Traffic Router
- Traffic Stats
-- Traffic Vault
-- CI tests
+- Grove
+- CDN in a Box
+- Automation <!-- Please specify which (GitHub Actions, Docker images, Ansible Roles, etc.) -->
+- unknown
## What is the best way to verify this PR?
-<!-- Please include here ALL the steps necessary to test your Pull Request. If
-it includes tests (and most should), outline here the steps needed to run the
-tests. If not, lay out the manual testing procedure and please explain why
-tests are unnecessary for this Pull Request. -->
+<!-- Please include here ALL the steps necessary to test your Pull Request.
+If your PR includes tests (and most should), provide the steps needed to run the tests.
+If not, please provide step-by-step instructions to test the PR manually and explain why your PR does not need tests. -->
-## If this is a bug fix, what versions of Traffic Control are affected?
-<!-- If this PR fixes a bug, please list here all of the affected versions - to
-the best of your knowledge. It's also pretty helpful to include a commit hash
-of where 'master' is at the time this PR is opened (if it affects master),
-because what 'master' means will change over time. For example, if this PR
-fixes a bug that's present in master (at commit hash '1df853c8'), in v4.0.0,
-and in the current 4.0.1 Release candidate (e.g. RC1), then this list would
-look like:
-- master (1df853c8)
-- 4.0.0
-- 4.0.1 (RC1)
-
-If you don't know what other versions might have this bug, AND don't know how
-to find the commit hash of 'master', then feel free to leave this section
-blank (or, preferably, delete it entirely).
+## If this is a bugfix, which Traffic Control versions contained the bug?
+<!-- Delete this section if the PR is not a bugfix, or if the bug is only in the master branch.
+Examples:
+- 5.1.2
+- 5.1.3 (RC1)
-->
## The following criteria are ALL met by this PR
-<!-- Check the boxes to signify that the associated statement is true. To
-"check a box", replace the space inside of the square brackets with an 'x'.
-e.g.
-
-- [ x] <- Wrong
-- [x ] <- Wrong
-- [] <- Wrong
-- [*] <- Wrong
-- [x] <- Correct!
-
--->
-
-- [ ] This PR includes tests OR I have explained why tests are unnecessary
-- [ ] This PR includes documentation OR I have explained why documentation is unnecessary
-- [ ] This PR includes an update to CHANGELOG.md OR such an update is not necessary
-- [ ] This PR includes any and all required license headers
-- [ ] This PR **DOES NOT FIX A SERIOUS SECURITY VULNERABILITY** (see [the Apache Software Foundation's security guidelines](https://www.apache.org/security/) for details)
-
-
-## Additional Information
-<!-- If you would like to include any additional information on the PR for
-potential reviewers please put it here.
-
-Some examples of this would be:
-
-- Before and after screenshots/gifs of the Traffic Portal if it is affected
-- Links to other dependent Pull Requests
-- References to relevant context (e.g. new/updates to dependent libraries,
-mailing list records, blueprints)
-
-Feel free to leave this section blank (or, preferably, delete it entirely).
--->
+<!-- Check each box to signify that the associated statement is true. For example:
Review comment:
Thoughts on removing checkbox instructions?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] mitchell852 commented on a change in pull request #6055: Shorten and clarify PR and Issue templates
Posted by GitBox <gi...@apache.org>.
mitchell852 commented on a change in pull request #6055:
URL: https://github.com/apache/trafficcontrol/pull/6055#discussion_r684386300
##########
File path: .github/ISSUE_TEMPLATE/3-improvement-request.md
##########
@@ -1,79 +1,62 @@
---
+# 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
+#
+# http://www.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.
+#
name: Improvement request
-
-about: Suggest how to improve Traffic Control. Examples include usability, performance, tech debt, etc.
-
+about: Suggest how to improve an existing feature of Traffic Control (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 security@trafficcontrol.apache.org and follow the
-guidelines at https://www.apache.org/security/ regarding vulnerability disclosure.
+guidelines at https://apache.org/security regarding vulnerability disclosure.
- For *SUPPORT QUESTIONS*, use the #traffic-control channel on the ASF slack (https://s.apache.org/slack-invite)
-or Traffic Control mailing lists (https://trafficcontrol.apache.org/mailing_lists).
-- Before submitting, please **SEARCH GITHUB** for a similar issue or PR.
+or the Traffic Control Users mailing list (send an email to users-subscribe@trafficcontrol.apache.org to subscribe).
+- Before submitting, please **SEARCH GITHUB** for a similar issue or PR
+ * https://github.com/apache/trafficcontrol/issues
+ * https://github.com/apache/trafficcontrol/pulls
-->
## I'm submitting a ...
Review comment:
should this just say "i'm submitting a improvement request related to:"
```
usability
performance
tech debt
other
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request #6055: Shorten and clarify PR and Issue templates
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #6055:
URL: https://github.com/apache/trafficcontrol/pull/6055#discussion_r684380772
##########
File path: .github/ISSUE_TEMPLATE/2-feature-request.md
##########
@@ -1,79 +1,62 @@
---
+# 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
+#
+# http://www.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.
+#
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 security@trafficcontrol.apache.org and follow the
-guidelines at https://www.apache.org/security/ regarding vulnerability disclosure.
+guidelines at https://apache.org/security regarding vulnerability disclosure.
- For *SUPPORT QUESTIONS*, use the #traffic-control channel on the ASF slack (https://s.apache.org/slack-invite)
-or Traffic Control mailing lists (https://trafficcontrol.apache.org/mailing_lists).
-- Before submitting, please **SEARCH GITHUB** for a similar issue or PR.
+or the Traffic Control Users mailing list (send an email to users-subscribe@trafficcontrol.apache.org to subscribe).
+- Before submitting, please **SEARCH GITHUB** for a similar issue or PR
+ * https://github.com/apache/trafficcontrol/issues
+ * https://github.com/apache/trafficcontrol/pulls
-->
## 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)-->
+<!-- Do not submit a security vulnerability here - see above security vulnerability info -->
+- [x] new feature / enhancement request
+<!-- 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
+- Traffic Control Cache Config (T3C)
+- Traffic Control Client <!-- Please specify which (Python, Go, or Java) -->
+- Traffic Monitor
+- Traffic Ops
+- Traffic Portal
+- Traffic Router
+- Traffic Stats
+- Grove
+- Documentation
+- CDN in a Box
+- Automation (GitHub Actions, Ansible Roles)
+- unknown
## Current behavior:
Review comment:
> but i have no problem combining them. in the issue template and the labels.
Do they need to be combined, now that *enhancement* has been renamed to *new feature*?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request #6055: Shorten and clarify PR and Issue templates
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #6055:
URL: https://github.com/apache/trafficcontrol/pull/6055#discussion_r675864589
##########
File path: PULL_REQUEST_TEMPLATE.md
##########
@@ -1,104 +1,59 @@
<!--
************ STOP!! ************
If this Pull Request is intended to fix a security vulnerability, DO NOT submit it! Instead, contact
-the Apache Software Foundation Security Team at security@trafficcontrol.apache.org and follow the
-guidelines at https://www.apache.org/security/ regarding vulnerability disclosure.
+the Apache Traffic Control Security Team at security@trafficcontrol.apache.org and follow the
+guidelines at https://apache.org/security regarding vulnerability disclosure.
-->
## What does this PR (Pull Request) do?
-<!-- Explain the changes you made here. If this fixes an Issue, identify it by
-replacing the text in the checkbox item with the Issue number e.g.
+- [ ] This PR fixes #REPLACE_ME
Review comment:
Revamped in 050e91f9fd
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request #6055: Shorten and clarify PR and Issue templates
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #6055:
URL: https://github.com/apache/trafficcontrol/pull/6055#discussion_r675856650
##########
File path: .github/ISSUE_TEMPLATE/1-bug-report.md
##########
@@ -1,78 +1,66 @@
---
+# 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
+#
+# http://www.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.
+#
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 Traffic Control Security Team at security@trafficcontrol.apache.org and follow the
-guidelines at https://www.apache.org/security/ regarding vulnerability disclosure.
+guidelines at https://apache.org/security regarding vulnerability disclosure.
- For *SUPPORT QUESTIONS*, use the #traffic-control channel on the ASF slack (https://s.apache.org/slack-invite)
-or Traffic Control mailing lists (https://trafficcontrol.apache.org/mailing_lists).
-- Before submitting, please **SEARCH GITHUB** for a similar issue or PR.
+or the Traffic Control Users mailing list (send an email to users-subscribe@trafficcontrol.apache.org to subscribe).
+- Before submitting, please **SEARCH GITHUB** for a similar issue or PR
+ * https://github.com/apache/trafficcontrol/issues
+ * https://github.com/apache/trafficcontrol/pulls
-->
## I'm submitting a ...
-<!-- delete all those that don't apply -->
-<!--- security vulnerability (STOP!! - see above)-->
-- bug report
-- other <!--(Please do not submit support requests here - see above)-->
+<!-- Do not submit a security vulnerability here - see above security vulnerability info -->
+- [x] bug report
+<!--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
+## Traffic Control components affected ... <!-- delete all those that don't apply -->
Review comment:
I did not. I experimented with that, but Markdown renders it as part of the title, and I must have forgotten to move it back.
Moved back to underneath the header in 04ede1976e.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request #6055: Shorten and clarify PR and Issue templates
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #6055:
URL: https://github.com/apache/trafficcontrol/pull/6055#discussion_r675854445
##########
File path: PULL_REQUEST_TEMPLATE.md
##########
@@ -1,104 +1,59 @@
<!--
************ STOP!! ************
If this Pull Request is intended to fix a security vulnerability, DO NOT submit it! Instead, contact
-the Apache Software Foundation Security Team at security@trafficcontrol.apache.org and follow the
-guidelines at https://www.apache.org/security/ regarding vulnerability disclosure.
+the Apache Traffic Control Security Team at security@trafficcontrol.apache.org and follow the
+guidelines at https://apache.org/security regarding vulnerability disclosure.
-->
## What does this PR (Pull Request) do?
-<!-- Explain the changes you made here. If this fixes an Issue, identify it by
-replacing the text in the checkbox item with the Issue number e.g.
+- [ ] This PR fixes #REPLACE_ME
+<!-- Or you can say
+- [x] This PR is not related to any Issue
-- [x] This PR fixes #9001 OR is not related to any Issue
-
-^ This will automatically close Issue number 9001 when the Pull Request is
-merged (The '#' is important).
-
-Be sure you check the box properly, see the "The following criteria are ALL
-met by this PR" section for details.
--->
-
-- [ ] This PR fixes #REPLACE_ME OR is not related to any Issue <!-- You can check for an issue here: https://github.com/apache/trafficcontrol/issues -->
+A description of your PR goes here ↓ -->
## Which Traffic Control components are affected by this PR?
-<!-- Please delete all components from this list that are NOT affected by this
-Pull Request. Also, feel free to add the name of a tool or script that is
-affected but not on the list.
-
-Additionally, if this Pull Request does NOT affect documentation, please
-explain why documentation is not required. -->
-
-- CDN in a Box
-- Documentation
-- Grove
-- Traffic Control Client <!-- Please specify which; e.g. 'Python', 'Go', 'Java' -->
+<!-- Please delete all components from this list that are NOT affected by this Pull Request.
+Feel free to add the name of a tool or script that is affected but not on the list.
+-->
+- Documentation <!-- If this Pull Request does NOT affect documentation, please explain why. -->
+- Traffic Control Cache Config (T3C)
+- Traffic Control Client <!-- Please specify which (Python, Go, or Java) -->
- Traffic Monitor
- Traffic Ops
-- Traffic Ops ORT
- Traffic Portal
- Traffic Router
- Traffic Stats
-- Traffic Vault
-- CI tests
+- Grove
+- CDN in a Box
+- Automation <!-- Please specify which (GitHub Actions, Docker images, Ansible Roles, etc.) -->
+- unknown
## What is the best way to verify this PR?
-<!-- Please include here ALL the steps necessary to test your Pull Request. If
-it includes tests (and most should), outline here the steps needed to run the
-tests. If not, lay out the manual testing procedure and please explain why
-tests are unnecessary for this Pull Request. -->
+<!-- Please include here ALL the steps necessary to test your Pull Request.
Review comment:
Abbreviated to PR in cce01b21e4
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] mitchell852 edited a comment on pull request #6055: Shorten and clarify PR and Issue templates
Posted by GitBox <gi...@apache.org>.
mitchell852 edited a comment on pull request #6055:
URL: https://github.com/apache/trafficcontrol/pull/6055#issuecomment-888400646
nit:
```
## I'm submitting a ...
<!-- Do not submit a security vulnerability here - see above security vulnerability info -->
- [x] bug report
<!-- Please do not submit support requests here - see above-->
```
want to move the 2 comments to the top like this? same with other issue templates.
```
## I'm submitting a ...
<!-- Do not submit a security vulnerability here - see above security vulnerability info -->
<!-- Please do not submit support requests here - see above-->
- [x] bug report
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] zrhoffman commented on pull request #6055: Shorten and clarify PR and Issue templates
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on pull request #6055:
URL: https://github.com/apache/trafficcontrol/pull/6055#issuecomment-894419027
By @mitchell852's suggestion, combined the Issue type title with the *Traffic Control components affected ...* section in 87b8eb1913
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request #6055: Shorten and clarify PR and Issue templates
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #6055:
URL: https://github.com/apache/trafficcontrol/pull/6055#discussion_r675857797
##########
File path: .github/ISSUE_TEMPLATE/1-bug-report.md
##########
@@ -1,78 +1,66 @@
---
+# 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
+#
+# http://www.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.
+#
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 Traffic Control Security Team at security@trafficcontrol.apache.org and follow the
-guidelines at https://www.apache.org/security/ regarding vulnerability disclosure.
+guidelines at https://apache.org/security regarding vulnerability disclosure.
- For *SUPPORT QUESTIONS*, use the #traffic-control channel on the ASF slack (https://s.apache.org/slack-invite)
-or Traffic Control mailing lists (https://trafficcontrol.apache.org/mailing_lists).
-- Before submitting, please **SEARCH GITHUB** for a similar issue or PR.
+or the Traffic Control Users mailing list (send an email to users-subscribe@trafficcontrol.apache.org to subscribe).
+- Before submitting, please **SEARCH GITHUB** for a similar issue or PR
+ * https://github.com/apache/trafficcontrol/issues
+ * https://github.com/apache/trafficcontrol/pulls
-->
## I'm submitting a ...
-<!-- delete all those that don't apply -->
-<!--- security vulnerability (STOP!! - see above)-->
-- bug report
-- other <!--(Please do not submit support requests here - see above)-->
+<!-- Do not submit a security vulnerability here - see above security vulnerability info -->
+- [x] bug report
+<!--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
+## Traffic Control components affected ... <!-- delete all those that don't apply -->
+- Traffic Control Cache Config (T3C)
+- Traffic Control Client <!-- Please specify which (Python, Go, or Java) -->
+- Traffic Monitor
+- Traffic Ops
+- Traffic Portal
+- Traffic Router
+- Traffic Stats
+- Grove
+- Documentation
+- CDN in a Box
+- Automation <!-- Please specify which (GitHub Actions, Docker images, Ansible Roles, etc.) -->
+- unknown
## Current behavior:
-<!-- Describe how the bug manifests -->
+<!-- Describe how the bug happens -->
## Expected behavior:
<!-- Describe what the behavior would be without the bug -->
+
Review comment:
Added a second line in *Current behavior* section that was missing before in 4f856db629.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request #6055: Shorten and clarify PR and Issue templates
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #6055:
URL: https://github.com/apache/trafficcontrol/pull/6055#discussion_r675872416
##########
File path: PULL_REQUEST_TEMPLATE.md
##########
@@ -1,104 +1,59 @@
<!--
************ STOP!! ************
If this Pull Request is intended to fix a security vulnerability, DO NOT submit it! Instead, contact
-the Apache Software Foundation Security Team at security@trafficcontrol.apache.org and follow the
-guidelines at https://www.apache.org/security/ regarding vulnerability disclosure.
+the Apache Traffic Control Security Team at security@trafficcontrol.apache.org and follow the
+guidelines at https://apache.org/security regarding vulnerability disclosure.
-->
## What does this PR (Pull Request) do?
-<!-- Explain the changes you made here. If this fixes an Issue, identify it by
-replacing the text in the checkbox item with the Issue number e.g.
+- [ ] This PR fixes #REPLACE_ME
+<!-- Or you can say
+- [x] This PR is not related to any Issue
-- [x] This PR fixes #9001 OR is not related to any Issue
-
-^ This will automatically close Issue number 9001 when the Pull Request is
-merged (The '#' is important).
-
-Be sure you check the box properly, see the "The following criteria are ALL
-met by this PR" section for details.
--->
-
-- [ ] This PR fixes #REPLACE_ME OR is not related to any Issue <!-- You can check for an issue here: https://github.com/apache/trafficcontrol/issues -->
+A description of your PR goes here ↓ -->
## Which Traffic Control components are affected by this PR?
-<!-- Please delete all components from this list that are NOT affected by this
-Pull Request. Also, feel free to add the name of a tool or script that is
-affected but not on the list.
-
-Additionally, if this Pull Request does NOT affect documentation, please
-explain why documentation is not required. -->
-
-- CDN in a Box
-- Documentation
-- Grove
-- Traffic Control Client <!-- Please specify which; e.g. 'Python', 'Go', 'Java' -->
+<!-- Please delete all components from this list that are NOT affected by this Pull Request.
+Feel free to add the name of a tool or script that is affected but not on the list.
+-->
+- Documentation <!-- If this Pull Request does NOT affect documentation, please explain why. -->
+- Traffic Control Cache Config (T3C)
+- Traffic Control Client <!-- Please specify which (Python, Go, or Java) -->
- Traffic Monitor
- Traffic Ops
-- Traffic Ops ORT
- Traffic Portal
- Traffic Router
- Traffic Stats
-- Traffic Vault
-- CI tests
+- Grove
+- CDN in a Box
+- Automation <!-- Please specify which (GitHub Actions, Docker images, Ansible Roles, etc.) -->
+- unknown
## What is the best way to verify this PR?
-<!-- Please include here ALL the steps necessary to test your Pull Request. If
-it includes tests (and most should), outline here the steps needed to run the
-tests. If not, lay out the manual testing procedure and please explain why
-tests are unnecessary for this Pull Request. -->
+<!-- Please include here ALL the steps necessary to test your Pull Request.
+If your PR includes tests (and most should), provide the steps needed to run the tests.
+If not, please provide step-by-step instructions to test the PR manually and explain why your PR does not need tests. -->
-## If this is a bug fix, what versions of Traffic Control are affected?
-<!-- If this PR fixes a bug, please list here all of the affected versions - to
-the best of your knowledge. It's also pretty helpful to include a commit hash
-of where 'master' is at the time this PR is opened (if it affects master),
-because what 'master' means will change over time. For example, if this PR
-fixes a bug that's present in master (at commit hash '1df853c8'), in v4.0.0,
-and in the current 4.0.1 Release candidate (e.g. RC1), then this list would
-look like:
-- master (1df853c8)
-- 4.0.0
-- 4.0.1 (RC1)
-
-If you don't know what other versions might have this bug, AND don't know how
-to find the commit hash of 'master', then feel free to leave this section
-blank (or, preferably, delete it entirely).
+## If this is a bugfix, which Traffic Control versions contained the bug?
+<!-- Delete this section if the PR is not a bugfix, or if the bug is only in the master branch.
+Examples:
+- 5.1.2
+- 5.1.3 (RC1)
-->
## The following criteria are ALL met by this PR
-<!-- Check the boxes to signify that the associated statement is true. To
-"check a box", replace the space inside of the square brackets with an 'x'.
-e.g.
-
-- [ x] <- Wrong
-- [x ] <- Wrong
-- [] <- Wrong
-- [*] <- Wrong
-- [x] <- Correct!
-
--->
-
-- [ ] This PR includes tests OR I have explained why tests are unnecessary
-- [ ] This PR includes documentation OR I have explained why documentation is unnecessary
-- [ ] This PR includes an update to CHANGELOG.md OR such an update is not necessary
-- [ ] This PR includes any and all required license headers
-- [ ] This PR **DOES NOT FIX A SERIOUS SECURITY VULNERABILITY** (see [the Apache Software Foundation's security guidelines](https://www.apache.org/security/) for details)
-
-
-## Additional Information
-<!-- If you would like to include any additional information on the PR for
-potential reviewers please put it here.
-
-Some examples of this would be:
-
-- Before and after screenshots/gifs of the Traffic Portal if it is affected
-- Links to other dependent Pull Requests
-- References to relevant context (e.g. new/updates to dependent libraries,
-mailing list records, blueprints)
-
-Feel free to leave this section blank (or, preferably, delete it entirely).
--->
+<!-- Check each box to signify that the associated statement is true. For example:
Review comment:
> We should have these checklists checked by default IMO and maybe reword the section title
Committed rewordings in 844e350032
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] mitchell852 commented on a change in pull request #6055: Shorten and clarify PR and Issue templates
Posted by GitBox <gi...@apache.org>.
mitchell852 commented on a change in pull request #6055:
URL: https://github.com/apache/trafficcontrol/pull/6055#discussion_r684386673
##########
File path: .github/ISSUE_TEMPLATE/2-feature-request.md
##########
@@ -1,79 +1,58 @@
---
+# 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
+#
+# http://www.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.
+#
name: Feature request
-
about: Suggest how to improve Traffic Control with something new
-
-labels: enhancement
-
+labels: new feature
---
-
<!--
************ STOP!! ************
If this issue identifies a security vulnerability, DO NOT submit it! Instead, contact
the Apache Traffic Control Security Team at security@trafficcontrol.apache.org and follow the
-guidelines at https://www.apache.org/security/ regarding vulnerability disclosure.
+guidelines at https://apache.org/security regarding vulnerability disclosure.
- For *SUPPORT QUESTIONS*, use the #traffic-control channel on the ASF slack (https://s.apache.org/slack-invite)
-or Traffic Control mailing lists (https://trafficcontrol.apache.org/mailing_lists).
-- Before submitting, please **SEARCH GITHUB** for a similar issue or PR.
+or the Traffic Control Users mailing list (send an email to users-subscribe@trafficcontrol.apache.org to subscribe).
+- Before submitting, please **SEARCH GITHUB** for a similar issue or PR
+ * https://github.com/apache/trafficcontrol/issues
+ * https://github.com/apache/trafficcontrol/pulls
-->
## I'm submitting a ...
Review comment:
should this just say "i'm submitting a new feature request" and get rid of the checkbox?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request #6055: Shorten and clarify PR and Issue templates
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #6055:
URL: https://github.com/apache/trafficcontrol/pull/6055#discussion_r678792908
##########
File path: .github/ISSUE_TEMPLATE/2-feature-request.md
##########
@@ -1,79 +1,62 @@
---
+# 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
+#
+# http://www.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.
+#
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 security@trafficcontrol.apache.org and follow the
-guidelines at https://www.apache.org/security/ regarding vulnerability disclosure.
+guidelines at https://apache.org/security regarding vulnerability disclosure.
- For *SUPPORT QUESTIONS*, use the #traffic-control channel on the ASF slack (https://s.apache.org/slack-invite)
-or Traffic Control mailing lists (https://trafficcontrol.apache.org/mailing_lists).
-- Before submitting, please **SEARCH GITHUB** for a similar issue or PR.
+or the Traffic Control Users mailing list (send an email to users-subscribe@trafficcontrol.apache.org to subscribe).
+- Before submitting, please **SEARCH GITHUB** for a similar issue or PR
+ * https://github.com/apache/trafficcontrol/issues
+ * https://github.com/apache/trafficcontrol/pulls
-->
## 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)-->
+<!-- Do not submit a security vulnerability here - see above security vulnerability info -->
+- [x] new feature / enhancement request
+<!-- 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
+- Traffic Control Cache Config (T3C)
+- Traffic Control Client <!-- Please specify which (Python, Go, or Java) -->
+- Traffic Monitor
+- Traffic Ops
+- Traffic Portal
+- Traffic Router
+- Traffic Stats
+- Grove
+- Documentation
+- CDN in a Box
+- Automation (GitHub Actions, Ansible Roles)
+- unknown
## Current behavior:
Review comment:
> seems like `Current Behavior` could be removed from the feature request template to make it even easier...
> Yeah, maybe combine it into this?
Combined in b6b04bee11.
> I guess we should probably do something similar for the improvement request and bug report?
I don't think that we should combine *Current behavior* and *Expected behavior* in the bug report, although maybe we could reorder them. The [Go issue template](https://github.com/golang/go/blob/9eee0ed439/.github/ISSUE_TEMPLATE#L24-L38) asks
* What did you do?
* What did you expect to see?
* What did you see instead?
Asking those 3 questions is a good model for bug reports IMO.
> Now that I type that out, do we even need to differentiate between improvement and feature requests? Those two have always been kind of confusing. Maybe we should get rid of one altogether?
> The lines between those are blurry, IMO.
If *improvement* and *new feature* seem similar, we should definitely reword it in the templates to make the difference clearer.
Pushed changes to the *Improvement request* template:
* Replaced *feature* with *change* in 54c7df03f2
* Removed the *Minimal reproduction of the problem with instructions* section in 9e09a8ca92
* Changed the description on https://github.com/apache/trafficcontrol/issues/new/choose to
> Suggest how to improve an existing feature of Traffic Control (usability, performance, tech debt, etc.)
in d1b3d70726
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request #6055: Shorten and clarify PR and Issue templates
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #6055:
URL: https://github.com/apache/trafficcontrol/pull/6055#discussion_r678747198
##########
File path: .github/ISSUE_TEMPLATE/1-bug-report.md
##########
@@ -1,78 +1,68 @@
---
+# 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
+#
+# http://www.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.
+#
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 Traffic Control Security Team at security@trafficcontrol.apache.org and follow the
-guidelines at https://www.apache.org/security/ regarding vulnerability disclosure.
+guidelines at https://apache.org/security regarding vulnerability disclosure.
- For *SUPPORT QUESTIONS*, use the #traffic-control channel on the ASF slack (https://s.apache.org/slack-invite)
-or Traffic Control mailing lists (https://trafficcontrol.apache.org/mailing_lists).
-- Before submitting, please **SEARCH GITHUB** for a similar issue or PR.
+or the Traffic Control Users mailing list (send an email to users-subscribe@trafficcontrol.apache.org to subscribe).
+- Before submitting, please **SEARCH GITHUB** for a similar issue or PR
+ * https://github.com/apache/trafficcontrol/issues
+ * https://github.com/apache/trafficcontrol/pulls
-->
## I'm submitting a ...
-<!-- delete all those that don't apply -->
-<!--- security vulnerability (STOP!! - see above)-->
-- bug report
-- other <!--(Please do not submit support requests here - see above)-->
+<!-- Do not submit a security vulnerability here - see above security vulnerability info -->
+- [x] bug report
+<!-- 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
+- Traffic Control Cache Config (T3C)
Review comment:
Noted in 1ca63d0e5e.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request #6055: Shorten and clarify PR and Issue templates
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #6055:
URL: https://github.com/apache/trafficcontrol/pull/6055#discussion_r678794201
##########
File path: .github/ISSUE_TEMPLATE/2-feature-request.md
##########
@@ -1,79 +1,62 @@
---
+# 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
+#
+# http://www.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.
+#
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 security@trafficcontrol.apache.org and follow the
-guidelines at https://www.apache.org/security/ regarding vulnerability disclosure.
+guidelines at https://apache.org/security regarding vulnerability disclosure.
- For *SUPPORT QUESTIONS*, use the #traffic-control channel on the ASF slack (https://s.apache.org/slack-invite)
-or Traffic Control mailing lists (https://trafficcontrol.apache.org/mailing_lists).
-- Before submitting, please **SEARCH GITHUB** for a similar issue or PR.
+or the Traffic Control Users mailing list (send an email to users-subscribe@trafficcontrol.apache.org to subscribe).
+- Before submitting, please **SEARCH GITHUB** for a similar issue or PR
+ * https://github.com/apache/trafficcontrol/issues
+ * https://github.com/apache/trafficcontrol/pulls
-->
## 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)-->
+<!-- Do not submit a security vulnerability here - see above security vulnerability info -->
+- [x] new feature / enhancement request
+<!-- 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
+- Traffic Control Cache Config (T3C)
+- Traffic Control Client <!-- Please specify which (Python, Go, or Java) -->
+- Traffic Monitor
+- Traffic Ops
+- Traffic Portal
+- Traffic Router
+- Traffic Stats
+- Grove
+- Documentation
+- CDN in a Box
+- Automation (GitHub Actions, Ansible Roles)
+- unknown
## Current behavior:
Review comment:
> I'm also not sure we need both the `enhancement` and `improvement` labels, but that's a separate discussion.
What about renaming the *enhancement* label to *new feature*?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request #6055: Shorten and clarify PR and Issue templates
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #6055:
URL: https://github.com/apache/trafficcontrol/pull/6055#discussion_r675875408
##########
File path: PULL_REQUEST_TEMPLATE.md
##########
@@ -1,104 +1,55 @@
<!--
-************ STOP!! ************
-If this Pull Request is intended to fix a security vulnerability, DO NOT submit it! Instead, contact
-the Apache Software Foundation Security Team at security@trafficcontrol.apache.org and follow the
-guidelines at https://www.apache.org/security/ regarding vulnerability disclosure.
--->
-## What does this PR (Pull Request) do?
-<!-- Explain the changes you made here. If this fixes an Issue, identify it by
-replacing the text in the checkbox item with the Issue number e.g.
-
-- [x] This PR fixes #9001 OR is not related to any Issue
+Thank you for contributing! Please be sure to read our contribution guidelines: https://github.com/apache/trafficcontrol/blob/master/CONTRIBUTING.md
+If this closes or relates to an existing issue, please reference it using one of the following:
-^ This will automatically close Issue number 9001 when the Pull Request is
-merged (The '#' is important).
+closes: #ISSUE
+related: #ISSUE
-Be sure you check the box properly, see the "The following criteria are ALL
-met by this PR" section for details.
+If this PR fixes a security vulnerability, DO NOT submit! Instead, contact
+the Apache Traffic Control Security Team at security@trafficcontrol.apache.org and follow the
+guidelines at https://apache.org/security regarding vulnerability disclosure.
-->
-- [ ] This PR fixes #REPLACE_ME OR is not related to any Issue <!-- You can check for an issue here: https://github.com/apache/trafficcontrol/issues -->
+---
+**^ Add meaningful description above**
## Which Traffic Control components are affected by this PR?
-<!-- Please delete all components from this list that are NOT affected by this
-Pull Request. Also, feel free to add the name of a tool or script that is
-affected but not on the list.
-
-Additionally, if this Pull Request does NOT affect documentation, please
-explain why documentation is not required. -->
-
-- CDN in a Box
+<!-- Please delete all components from this list that are NOT affected by this PR.
+Feel free to add the name of a tool or script that is affected but not on the list.
+-->
- Documentation
-- Grove
-- Traffic Control Client <!-- Please specify which; e.g. 'Python', 'Go', 'Java' -->
+- Traffic Control Cache Config (T3C)
+- Traffic Control Client <!-- Please specify which (Python, Go, or Java) -->
- Traffic Monitor
- Traffic Ops
-- Traffic Ops ORT
- Traffic Portal
- Traffic Router
- Traffic Stats
-- Traffic Vault
-- CI tests
+- Grove
+- CDN in a Box
+- Automation <!-- Please specify which (GitHub Actions, Docker images, Ansible Roles, etc.) -->
+- unknown
## What is the best way to verify this PR?
-<!-- Please include here ALL the steps necessary to test your Pull Request. If
-it includes tests (and most should), outline here the steps needed to run the
-tests. If not, lay out the manual testing procedure and please explain why
-tests are unnecessary for this Pull Request. -->
-
-## If this is a bug fix, what versions of Traffic Control are affected?
-<!-- If this PR fixes a bug, please list here all of the affected versions - to
-the best of your knowledge. It's also pretty helpful to include a commit hash
-of where 'master' is at the time this PR is opened (if it affects master),
-because what 'master' means will change over time. For example, if this PR
-fixes a bug that's present in master (at commit hash '1df853c8'), in v4.0.0,
-and in the current 4.0.1 Release candidate (e.g. RC1), then this list would
-look like:
+<!-- Please include here ALL the steps necessary to test your PR.
+If your PR includes tests (and most should), provide the steps needed to run the tests.
+If not, please provide step-by-step instructions to test the PR manually and explain why your PR does not need tests. -->
-- master (1df853c8)
-- 4.0.0
-- 4.0.1 (RC1)
-If you don't know what other versions might have this bug, AND don't know how
-to find the commit hash of 'master', then feel free to leave this section
-blank (or, preferably, delete it entirely).
+## If this is a bugfix, which Traffic Control versions contained the bug?
+<!-- Delete this section if the PR is not a bugfix, or if the bug is only in the master branch.
+Examples:
+- 5.1.2
+- 5.1.3 (RC1)
-->
-## The following criteria are ALL met by this PR
-<!-- Check the boxes to signify that the associated statement is true. To
-"check a box", replace the space inside of the square brackets with an 'x'.
-e.g.
-
-- [ x] <- Wrong
-- [x ] <- Wrong
-- [] <- Wrong
-- [*] <- Wrong
-- [x] <- Correct!
-
--->
-
-- [ ] This PR includes tests OR I have explained why tests are unnecessary
-- [ ] This PR includes documentation OR I have explained why documentation is unnecessary
-- [ ] This PR includes an update to CHANGELOG.md OR such an update is not necessary
-- [ ] This PR includes any and all required license headers
-- [ ] This PR **DOES NOT FIX A SERIOUS SECURITY VULNERABILITY** (see [the Apache Software Foundation's security guidelines](https://www.apache.org/security/) for details)
-
-
-## Additional Information
-<!-- If you would like to include any additional information on the PR for
-potential reviewers please put it here.
-
-Some examples of this would be:
-
-- Before and after screenshots/gifs of the Traffic Portal if it is affected
-- Links to other dependent Pull Requests
-- References to relevant context (e.g. new/updates to dependent libraries,
-mailing list records, blueprints)
-
-Feel free to leave this section blank (or, preferably, delete it entirely).
--->
+## PR submission checklist
+- [x] This PR has tests <!-- If not, please delete this text and explain why this PR does not need tests. -->
+- [x] This PR has documentation <!-- If not, please delete this text and explain why this PR does not need documentation. -->
+- [x] This PR includes a CHANGELOG.md entry <!-- A fix for a bug from an ATC release, an improvement, or a new feature should include a changelog entry. -->
Review comment:
4c3095b2ae has this change
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] mitchell852 commented on a change in pull request #6055: Shorten and clarify PR and Issue templates
Posted by GitBox <gi...@apache.org>.
mitchell852 commented on a change in pull request #6055:
URL: https://github.com/apache/trafficcontrol/pull/6055#discussion_r680204031
##########
File path: .github/ISSUE_TEMPLATE/2-feature-request.md
##########
@@ -1,79 +1,62 @@
---
+# 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
+#
+# http://www.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.
+#
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 security@trafficcontrol.apache.org and follow the
-guidelines at https://www.apache.org/security/ regarding vulnerability disclosure.
+guidelines at https://apache.org/security regarding vulnerability disclosure.
- For *SUPPORT QUESTIONS*, use the #traffic-control channel on the ASF slack (https://s.apache.org/slack-invite)
-or Traffic Control mailing lists (https://trafficcontrol.apache.org/mailing_lists).
-- Before submitting, please **SEARCH GITHUB** for a similar issue or PR.
+or the Traffic Control Users mailing list (send an email to users-subscribe@trafficcontrol.apache.org to subscribe).
+- Before submitting, please **SEARCH GITHUB** for a similar issue or PR
+ * https://github.com/apache/trafficcontrol/issues
+ * https://github.com/apache/trafficcontrol/pulls
-->
## 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)-->
+<!-- Do not submit a security vulnerability here - see above security vulnerability info -->
+- [x] new feature / enhancement request
+<!-- 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
+- Traffic Control Cache Config (T3C)
+- Traffic Control Client <!-- Please specify which (Python, Go, or Java) -->
+- Traffic Monitor
+- Traffic Ops
+- Traffic Portal
+- Traffic Router
+- Traffic Stats
+- Grove
+- Documentation
+- CDN in a Box
+- Automation (GitHub Actions, Ansible Roles)
+- unknown
## Current behavior:
Review comment:
i think the diff between improvement and new feature/enhancement was supposed to be:
improvement: you can do this already but it's really painful so it needs improved
new feature: you can't do this at all
but i have no problem combining them. in the issue template and the labels.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] mitchell852 commented on a change in pull request #6055: Shorten and clarify PR and Issue templates
Posted by GitBox <gi...@apache.org>.
mitchell852 commented on a change in pull request #6055:
URL: https://github.com/apache/trafficcontrol/pull/6055#discussion_r684387308
##########
File path: .github/ISSUE_TEMPLATE/2-feature-request.md
##########
@@ -1,79 +1,58 @@
---
+# 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
+#
+# http://www.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.
+#
name: Feature request
-
about: Suggest how to improve Traffic Control with something new
-
-labels: enhancement
-
+labels: new feature
---
-
<!--
************ STOP!! ************
If this issue identifies a security vulnerability, DO NOT submit it! Instead, contact
the Apache Traffic Control Security Team at security@trafficcontrol.apache.org and follow the
-guidelines at https://www.apache.org/security/ regarding vulnerability disclosure.
+guidelines at https://apache.org/security regarding vulnerability disclosure.
- For *SUPPORT QUESTIONS*, use the #traffic-control channel on the ASF slack (https://s.apache.org/slack-invite)
-or Traffic Control mailing lists (https://trafficcontrol.apache.org/mailing_lists).
-- Before submitting, please **SEARCH GITHUB** for a similar issue or PR.
+or the Traffic Control Users mailing list (send an email to users-subscribe@trafficcontrol.apache.org to subscribe).
+- Before submitting, please **SEARCH GITHUB** for a similar issue or PR
+ * https://github.com/apache/trafficcontrol/issues
+ * https://github.com/apache/trafficcontrol/pulls
-->
## I'm submitting a ...
Review comment:
or maybe we can think of some checkboxes...
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] mitchell852 commented on a change in pull request #6055: Shorten and clarify PR and Issue templates
Posted by GitBox <gi...@apache.org>.
mitchell852 commented on a change in pull request #6055:
URL: https://github.com/apache/trafficcontrol/pull/6055#discussion_r678436930
##########
File path: .github/ISSUE_TEMPLATE/2-feature-request.md
##########
@@ -1,79 +1,62 @@
---
+# 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
+#
+# http://www.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.
+#
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 security@trafficcontrol.apache.org and follow the
-guidelines at https://www.apache.org/security/ regarding vulnerability disclosure.
+guidelines at https://apache.org/security regarding vulnerability disclosure.
- For *SUPPORT QUESTIONS*, use the #traffic-control channel on the ASF slack (https://s.apache.org/slack-invite)
-or Traffic Control mailing lists (https://trafficcontrol.apache.org/mailing_lists).
-- Before submitting, please **SEARCH GITHUB** for a similar issue or PR.
+or the Traffic Control Users mailing list (send an email to users-subscribe@trafficcontrol.apache.org to subscribe).
+- Before submitting, please **SEARCH GITHUB** for a similar issue or PR
+ * https://github.com/apache/trafficcontrol/issues
+ * https://github.com/apache/trafficcontrol/pulls
-->
## 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)-->
+<!-- Do not submit a security vulnerability here - see above security vulnerability info -->
+- [x] new feature / enhancement request
+<!-- 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
+- Traffic Control Cache Config (T3C)
+- Traffic Control Client <!-- Please specify which (Python, Go, or Java) -->
+- Traffic Monitor
+- Traffic Ops
+- Traffic Portal
+- Traffic Router
+- Traffic Stats
+- Grove
+- Documentation
+- CDN in a Box
+- Automation (GitHub Actions, Ansible Roles)
+- unknown
## Current behavior:
Review comment:
seems like `Current Behavior` could be removed from the feature request template to make it even easier...
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] rawlinp commented on a change in pull request #6055: Shorten and clarify PR and Issue templates
Posted by GitBox <gi...@apache.org>.
rawlinp commented on a change in pull request #6055:
URL: https://github.com/apache/trafficcontrol/pull/6055#discussion_r675874051
##########
File path: PULL_REQUEST_TEMPLATE.md
##########
@@ -1,104 +1,55 @@
<!--
-************ STOP!! ************
-If this Pull Request is intended to fix a security vulnerability, DO NOT submit it! Instead, contact
-the Apache Software Foundation Security Team at security@trafficcontrol.apache.org and follow the
-guidelines at https://www.apache.org/security/ regarding vulnerability disclosure.
--->
-## What does this PR (Pull Request) do?
-<!-- Explain the changes you made here. If this fixes an Issue, identify it by
-replacing the text in the checkbox item with the Issue number e.g.
-
-- [x] This PR fixes #9001 OR is not related to any Issue
+Thank you for contributing! Please be sure to read our contribution guidelines: https://github.com/apache/trafficcontrol/blob/master/CONTRIBUTING.md
+If this closes or relates to an existing issue, please reference it using one of the following:
-^ This will automatically close Issue number 9001 when the Pull Request is
-merged (The '#' is important).
+closes: #ISSUE
+related: #ISSUE
-Be sure you check the box properly, see the "The following criteria are ALL
-met by this PR" section for details.
+If this PR fixes a security vulnerability, DO NOT submit! Instead, contact
+the Apache Traffic Control Security Team at security@trafficcontrol.apache.org and follow the
+guidelines at https://apache.org/security regarding vulnerability disclosure.
-->
-- [ ] This PR fixes #REPLACE_ME OR is not related to any Issue <!-- You can check for an issue here: https://github.com/apache/trafficcontrol/issues -->
+---
+**^ Add meaningful description above**
## Which Traffic Control components are affected by this PR?
-<!-- Please delete all components from this list that are NOT affected by this
-Pull Request. Also, feel free to add the name of a tool or script that is
-affected but not on the list.
-
-Additionally, if this Pull Request does NOT affect documentation, please
-explain why documentation is not required. -->
-
-- CDN in a Box
+<!-- Please delete all components from this list that are NOT affected by this PR.
+Feel free to add the name of a tool or script that is affected but not on the list.
+-->
- Documentation
-- Grove
-- Traffic Control Client <!-- Please specify which; e.g. 'Python', 'Go', 'Java' -->
+- Traffic Control Cache Config (T3C)
+- Traffic Control Client <!-- Please specify which (Python, Go, or Java) -->
- Traffic Monitor
- Traffic Ops
-- Traffic Ops ORT
- Traffic Portal
- Traffic Router
- Traffic Stats
-- Traffic Vault
-- CI tests
+- Grove
+- CDN in a Box
+- Automation <!-- Please specify which (GitHub Actions, Docker images, Ansible Roles, etc.) -->
+- unknown
## What is the best way to verify this PR?
-<!-- Please include here ALL the steps necessary to test your Pull Request. If
-it includes tests (and most should), outline here the steps needed to run the
-tests. If not, lay out the manual testing procedure and please explain why
-tests are unnecessary for this Pull Request. -->
-
-## If this is a bug fix, what versions of Traffic Control are affected?
-<!-- If this PR fixes a bug, please list here all of the affected versions - to
-the best of your knowledge. It's also pretty helpful to include a commit hash
-of where 'master' is at the time this PR is opened (if it affects master),
-because what 'master' means will change over time. For example, if this PR
-fixes a bug that's present in master (at commit hash '1df853c8'), in v4.0.0,
-and in the current 4.0.1 Release candidate (e.g. RC1), then this list would
-look like:
+<!-- Please include here ALL the steps necessary to test your PR.
+If your PR includes tests (and most should), provide the steps needed to run the tests.
+If not, please provide step-by-step instructions to test the PR manually and explain why your PR does not need tests. -->
-- master (1df853c8)
-- 4.0.0
-- 4.0.1 (RC1)
-If you don't know what other versions might have this bug, AND don't know how
-to find the commit hash of 'master', then feel free to leave this section
-blank (or, preferably, delete it entirely).
+## If this is a bugfix, which Traffic Control versions contained the bug?
+<!-- Delete this section if the PR is not a bugfix, or if the bug is only in the master branch.
+Examples:
+- 5.1.2
+- 5.1.3 (RC1)
-->
-## The following criteria are ALL met by this PR
-<!-- Check the boxes to signify that the associated statement is true. To
-"check a box", replace the space inside of the square brackets with an 'x'.
-e.g.
-
-- [ x] <- Wrong
-- [x ] <- Wrong
-- [] <- Wrong
-- [*] <- Wrong
-- [x] <- Correct!
-
--->
-
-- [ ] This PR includes tests OR I have explained why tests are unnecessary
-- [ ] This PR includes documentation OR I have explained why documentation is unnecessary
-- [ ] This PR includes an update to CHANGELOG.md OR such an update is not necessary
-- [ ] This PR includes any and all required license headers
-- [ ] This PR **DOES NOT FIX A SERIOUS SECURITY VULNERABILITY** (see [the Apache Software Foundation's security guidelines](https://www.apache.org/security/) for details)
-
-
-## Additional Information
-<!-- If you would like to include any additional information on the PR for
-potential reviewers please put it here.
-
-Some examples of this would be:
-
-- Before and after screenshots/gifs of the Traffic Portal if it is affected
-- Links to other dependent Pull Requests
-- References to relevant context (e.g. new/updates to dependent libraries,
-mailing list records, blueprints)
-
-Feel free to leave this section blank (or, preferably, delete it entirely).
--->
+## PR submission checklist
+- [x] This PR has tests <!-- If not, please delete this text and explain why this PR does not need tests. -->
+- [x] This PR has documentation <!-- If not, please delete this text and explain why this PR does not need documentation. -->
+- [x] This PR includes a CHANGELOG.md entry <!-- A fix for a bug from an ATC release, an improvement, or a new feature should include a changelog entry. -->
Review comment:
We should probably change `includes` to `has` for this line as well -- that's my bad for missing it in the suggestion :)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] rawlinp commented on a change in pull request #6055: Shorten and clarify PR and Issue templates
Posted by GitBox <gi...@apache.org>.
rawlinp commented on a change in pull request #6055:
URL: https://github.com/apache/trafficcontrol/pull/6055#discussion_r675861164
##########
File path: PULL_REQUEST_TEMPLATE.md
##########
@@ -1,104 +1,59 @@
<!--
************ STOP!! ************
If this Pull Request is intended to fix a security vulnerability, DO NOT submit it! Instead, contact
-the Apache Software Foundation Security Team at security@trafficcontrol.apache.org and follow the
-guidelines at https://www.apache.org/security/ regarding vulnerability disclosure.
+the Apache Traffic Control Security Team at security@trafficcontrol.apache.org and follow the
+guidelines at https://apache.org/security regarding vulnerability disclosure.
-->
## What does this PR (Pull Request) do?
-<!-- Explain the changes you made here. If this fixes an Issue, identify it by
-replacing the text in the checkbox item with the Issue number e.g.
+- [ ] This PR fixes #REPLACE_ME
Review comment:
It seems to work for linking. I tried it in my fork, and the issue got the message `May be fixed by #9`.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] rawlinp commented on a change in pull request #6055: Shorten and clarify PR and Issue templates
Posted by GitBox <gi...@apache.org>.
rawlinp commented on a change in pull request #6055:
URL: https://github.com/apache/trafficcontrol/pull/6055#discussion_r675804829
##########
File path: .github/ISSUE_TEMPLATE/1-bug-report.md
##########
@@ -1,78 +1,66 @@
---
+# 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
+#
+# http://www.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.
+#
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 Traffic Control Security Team at security@trafficcontrol.apache.org and follow the
-guidelines at https://www.apache.org/security/ regarding vulnerability disclosure.
+guidelines at https://apache.org/security regarding vulnerability disclosure.
- For *SUPPORT QUESTIONS*, use the #traffic-control channel on the ASF slack (https://s.apache.org/slack-invite)
-or Traffic Control mailing lists (https://trafficcontrol.apache.org/mailing_lists).
-- Before submitting, please **SEARCH GITHUB** for a similar issue or PR.
+or the Traffic Control Users mailing list (send an email to users-subscribe@trafficcontrol.apache.org to subscribe).
+- Before submitting, please **SEARCH GITHUB** for a similar issue or PR
+ * https://github.com/apache/trafficcontrol/issues
+ * https://github.com/apache/trafficcontrol/pulls
-->
## I'm submitting a ...
-<!-- delete all those that don't apply -->
-<!--- security vulnerability (STOP!! - see above)-->
-- bug report
-- other <!--(Please do not submit support requests here - see above)-->
+<!-- Do not submit a security vulnerability here - see above security vulnerability info -->
+- [x] bug report
+<!--Please do not submit support requests here - see above-->
Review comment:
this could use a space between the comment markers and the comment text
##########
File path: .github/ISSUE_TEMPLATE/1-bug-report.md
##########
@@ -1,78 +1,66 @@
---
+# 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
+#
+# http://www.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.
+#
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 Traffic Control Security Team at security@trafficcontrol.apache.org and follow the
-guidelines at https://www.apache.org/security/ regarding vulnerability disclosure.
+guidelines at https://apache.org/security regarding vulnerability disclosure.
- For *SUPPORT QUESTIONS*, use the #traffic-control channel on the ASF slack (https://s.apache.org/slack-invite)
-or Traffic Control mailing lists (https://trafficcontrol.apache.org/mailing_lists).
-- Before submitting, please **SEARCH GITHUB** for a similar issue or PR.
+or the Traffic Control Users mailing list (send an email to users-subscribe@trafficcontrol.apache.org to subscribe).
+- Before submitting, please **SEARCH GITHUB** for a similar issue or PR
+ * https://github.com/apache/trafficcontrol/issues
+ * https://github.com/apache/trafficcontrol/pulls
-->
## I'm submitting a ...
-<!-- delete all those that don't apply -->
-<!--- security vulnerability (STOP!! - see above)-->
-- bug report
-- other <!--(Please do not submit support requests here - see above)-->
+<!-- Do not submit a security vulnerability here - see above security vulnerability info -->
+- [x] bug report
+<!--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
+## Traffic Control components affected ... <!-- delete all those that don't apply -->
Review comment:
Did you mean to move `delete all ...` up to this line? I don't see it moved up on the other templates, and personally I like it underneath the header.
##########
File path: .github/ISSUE_TEMPLATE/1-bug-report.md
##########
@@ -1,78 +1,66 @@
---
+# 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
+#
+# http://www.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.
+#
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 Traffic Control Security Team at security@trafficcontrol.apache.org and follow the
-guidelines at https://www.apache.org/security/ regarding vulnerability disclosure.
+guidelines at https://apache.org/security regarding vulnerability disclosure.
- For *SUPPORT QUESTIONS*, use the #traffic-control channel on the ASF slack (https://s.apache.org/slack-invite)
-or Traffic Control mailing lists (https://trafficcontrol.apache.org/mailing_lists).
-- Before submitting, please **SEARCH GITHUB** for a similar issue or PR.
+or the Traffic Control Users mailing list (send an email to users-subscribe@trafficcontrol.apache.org to subscribe).
+- Before submitting, please **SEARCH GITHUB** for a similar issue or PR
+ * https://github.com/apache/trafficcontrol/issues
+ * https://github.com/apache/trafficcontrol/pulls
-->
## I'm submitting a ...
-<!-- delete all those that don't apply -->
-<!--- security vulnerability (STOP!! - see above)-->
-- bug report
-- other <!--(Please do not submit support requests here - see above)-->
+<!-- Do not submit a security vulnerability here - see above security vulnerability info -->
+- [x] bug report
+<!--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
+## Traffic Control components affected ... <!-- delete all those that don't apply -->
+- Traffic Control Cache Config (T3C)
+- Traffic Control Client <!-- Please specify which (Python, Go, or Java) -->
+- Traffic Monitor
+- Traffic Ops
+- Traffic Portal
+- Traffic Router
+- Traffic Stats
+- Grove
+- Documentation
+- CDN in a Box
+- Automation <!-- Please specify which (GitHub Actions, Docker images, Ansible Roles, etc.) -->
+- unknown
## Current behavior:
-<!-- Describe how the bug manifests -->
+<!-- Describe how the bug happens -->
## Expected behavior:
<!-- Describe what the behavior would be without the bug -->
+
Review comment:
I like this line -- we should have two empty lines between all sections. That makes it easier to start typing on the 1st line while keeping an empty line between sections.
##########
File path: PULL_REQUEST_TEMPLATE.md
##########
@@ -1,104 +1,59 @@
<!--
************ STOP!! ************
If this Pull Request is intended to fix a security vulnerability, DO NOT submit it! Instead, contact
-the Apache Software Foundation Security Team at security@trafficcontrol.apache.org and follow the
-guidelines at https://www.apache.org/security/ regarding vulnerability disclosure.
+the Apache Traffic Control Security Team at security@trafficcontrol.apache.org and follow the
+guidelines at https://apache.org/security regarding vulnerability disclosure.
-->
## What does this PR (Pull Request) do?
-<!-- Explain the changes you made here. If this fixes an Issue, identify it by
-replacing the text in the checkbox item with the Issue number e.g.
+- [ ] This PR fixes #REPLACE_ME
+<!-- Or you can say
+- [x] This PR is not related to any Issue
-- [x] This PR fixes #9001 OR is not related to any Issue
-
-^ This will automatically close Issue number 9001 when the Pull Request is
-merged (The '#' is important).
-
-Be sure you check the box properly, see the "The following criteria are ALL
-met by this PR" section for details.
--->
-
-- [ ] This PR fixes #REPLACE_ME OR is not related to any Issue <!-- You can check for an issue here: https://github.com/apache/trafficcontrol/issues -->
+A description of your PR goes here ↓ -->
## Which Traffic Control components are affected by this PR?
-<!-- Please delete all components from this list that are NOT affected by this
-Pull Request. Also, feel free to add the name of a tool or script that is
-affected but not on the list.
-
-Additionally, if this Pull Request does NOT affect documentation, please
-explain why documentation is not required. -->
-
-- CDN in a Box
-- Documentation
-- Grove
-- Traffic Control Client <!-- Please specify which; e.g. 'Python', 'Go', 'Java' -->
+<!-- Please delete all components from this list that are NOT affected by this Pull Request.
+Feel free to add the name of a tool or script that is affected but not on the list.
+-->
+- Documentation <!-- If this Pull Request does NOT affect documentation, please explain why. -->
+- Traffic Control Cache Config (T3C)
+- Traffic Control Client <!-- Please specify which (Python, Go, or Java) -->
- Traffic Monitor
- Traffic Ops
-- Traffic Ops ORT
- Traffic Portal
- Traffic Router
- Traffic Stats
-- Traffic Vault
-- CI tests
+- Grove
+- CDN in a Box
+- Automation <!-- Please specify which (GitHub Actions, Docker images, Ansible Roles, etc.) -->
+- unknown
## What is the best way to verify this PR?
-<!-- Please include here ALL the steps necessary to test your Pull Request. If
-it includes tests (and most should), outline here the steps needed to run the
-tests. If not, lay out the manual testing procedure and please explain why
-tests are unnecessary for this Pull Request. -->
+<!-- Please include here ALL the steps necessary to test your Pull Request.
+If your PR includes tests (and most should), provide the steps needed to run the tests.
+If not, please provide step-by-step instructions to test the PR manually and explain why your PR does not need tests. -->
-## If this is a bug fix, what versions of Traffic Control are affected?
-<!-- If this PR fixes a bug, please list here all of the affected versions - to
-the best of your knowledge. It's also pretty helpful to include a commit hash
-of where 'master' is at the time this PR is opened (if it affects master),
-because what 'master' means will change over time. For example, if this PR
-fixes a bug that's present in master (at commit hash '1df853c8'), in v4.0.0,
-and in the current 4.0.1 Release candidate (e.g. RC1), then this list would
-look like:
-- master (1df853c8)
-- 4.0.0
-- 4.0.1 (RC1)
-
-If you don't know what other versions might have this bug, AND don't know how
-to find the commit hash of 'master', then feel free to leave this section
-blank (or, preferably, delete it entirely).
+## If this is a bugfix, which Traffic Control versions contained the bug?
+<!-- Delete this section if the PR is not a bugfix, or if the bug is only in the master branch.
+Examples:
+- 5.1.2
+- 5.1.3 (RC1)
-->
## The following criteria are ALL met by this PR
-<!-- Check the boxes to signify that the associated statement is true. To
-"check a box", replace the space inside of the square brackets with an 'x'.
-e.g.
-
-- [ x] <- Wrong
-- [x ] <- Wrong
-- [] <- Wrong
-- [*] <- Wrong
-- [x] <- Correct!
-
--->
-
-- [ ] This PR includes tests OR I have explained why tests are unnecessary
-- [ ] This PR includes documentation OR I have explained why documentation is unnecessary
-- [ ] This PR includes an update to CHANGELOG.md OR such an update is not necessary
-- [ ] This PR includes any and all required license headers
-- [ ] This PR **DOES NOT FIX A SERIOUS SECURITY VULNERABILITY** (see [the Apache Software Foundation's security guidelines](https://www.apache.org/security/) for details)
-
-
-## Additional Information
-<!-- If you would like to include any additional information on the PR for
-potential reviewers please put it here.
-
-Some examples of this would be:
-
-- Before and after screenshots/gifs of the Traffic Portal if it is affected
-- Links to other dependent Pull Requests
-- References to relevant context (e.g. new/updates to dependent libraries,
-mailing list records, blueprints)
-
-Feel free to leave this section blank (or, preferably, delete it entirely).
--->
+<!-- Check each box to signify that the associated statement is true. For example:
Review comment:
We should have these checklists checked by default IMO and maybe reword the section title:
```
## PR submission checklist
[x] This PR has tests <!-- If not, please delete this text and explain why this PR does not need tests. -->
[x] This PR has documentation <!-- If not, please delete this text and explain why this PR does not need documentation. -->
[x] This PR includes a CHANGELOG.md entry <!-- A fix for a bug from an ATC release, an improvement, or a new feature should include a changelog entry. -->
[x] This PR **DOES NOT FIX A SERIOUS SECURITY VULNERABILITY** (see [the Apache Software Foundation's security guidelines](https://apache.org/security) for details)
```
That way, PRs that meet the criteria don't have to change anything in the checklist at all or check any boxes. We also don't have to tell people how to properly check a box.
##########
File path: .github/ISSUE_TEMPLATE/2-feature-request.md
##########
@@ -1,79 +1,62 @@
---
+# 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
+#
+# http://www.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.
+#
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 security@trafficcontrol.apache.org and follow the
-guidelines at https://www.apache.org/security/ regarding vulnerability disclosure.
+guidelines at https://apache.org/security regarding vulnerability disclosure.
- For *SUPPORT QUESTIONS*, use the #traffic-control channel on the ASF slack (https://s.apache.org/slack-invite)
-or Traffic Control mailing lists (https://trafficcontrol.apache.org/mailing_lists).
-- Before submitting, please **SEARCH GITHUB** for a similar issue or PR.
+or the Traffic Control Users mailing list (send an email to users-subscribe@trafficcontrol.apache.org to subscribe).
+- Before submitting, please **SEARCH GITHUB** for a similar issue or PR
+ * https://github.com/apache/trafficcontrol/issues
+ * https://github.com/apache/trafficcontrol/pulls
-->
## 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)-->
+<!-- Do not submit a security vulnerability here - see above security vulnerability info -->
+- [x] new feature / enhancement request
+<!--Please do not submit support requests here - see above-->
Review comment:
this could use a space between the comment markers and the comment text
##########
File path: PULL_REQUEST_TEMPLATE.md
##########
@@ -1,104 +1,59 @@
<!--
************ STOP!! ************
If this Pull Request is intended to fix a security vulnerability, DO NOT submit it! Instead, contact
-the Apache Software Foundation Security Team at security@trafficcontrol.apache.org and follow the
-guidelines at https://www.apache.org/security/ regarding vulnerability disclosure.
+the Apache Traffic Control Security Team at security@trafficcontrol.apache.org and follow the
+guidelines at https://apache.org/security regarding vulnerability disclosure.
-->
## What does this PR (Pull Request) do?
-<!-- Explain the changes you made here. If this fixes an Issue, identify it by
-replacing the text in the checkbox item with the Issue number e.g.
+- [ ] This PR fixes #REPLACE_ME
Review comment:
We should revamp this whole beginning to something more like what apache airflow did:
```
<!--
Thank you for contributing! Please be sure to read our contribution guidelines: https://github.com/apache/trafficcontrol/blob/master/CONTRIBUTING.md
If this closes or relates to an existing issue, please reference it using one of the following:
closes: #ISSUE
related: #ISSUE
If this PR fixes a security vulnerability, DO NOT submit! Instead, contact
the Apache Traffic Control Security Team at security@trafficcontrol.apache.org and follow the
guidelines at https://apache.org/security regarding vulnerability disclosure.
-->
---
**^ Add meaningful description above**
```
That eliminates an unnecessary checkbox, is way more inviting while still getting the security point across, and allows us to easily use the git commit message as the PR description (hopefully encouraging better commit messages as well).
##########
File path: PULL_REQUEST_TEMPLATE.md
##########
@@ -1,104 +1,59 @@
<!--
************ STOP!! ************
If this Pull Request is intended to fix a security vulnerability, DO NOT submit it! Instead, contact
-the Apache Software Foundation Security Team at security@trafficcontrol.apache.org and follow the
-guidelines at https://www.apache.org/security/ regarding vulnerability disclosure.
+the Apache Traffic Control Security Team at security@trafficcontrol.apache.org and follow the
+guidelines at https://apache.org/security regarding vulnerability disclosure.
-->
## What does this PR (Pull Request) do?
-<!-- Explain the changes you made here. If this fixes an Issue, identify it by
-replacing the text in the checkbox item with the Issue number e.g.
+- [ ] This PR fixes #REPLACE_ME
+<!-- Or you can say
+- [x] This PR is not related to any Issue
-- [x] This PR fixes #9001 OR is not related to any Issue
-
-^ This will automatically close Issue number 9001 when the Pull Request is
-merged (The '#' is important).
-
-Be sure you check the box properly, see the "The following criteria are ALL
-met by this PR" section for details.
--->
-
-- [ ] This PR fixes #REPLACE_ME OR is not related to any Issue <!-- You can check for an issue here: https://github.com/apache/trafficcontrol/issues -->
+A description of your PR goes here ↓ -->
## Which Traffic Control components are affected by this PR?
-<!-- Please delete all components from this list that are NOT affected by this
-Pull Request. Also, feel free to add the name of a tool or script that is
-affected but not on the list.
-
-Additionally, if this Pull Request does NOT affect documentation, please
-explain why documentation is not required. -->
-
-- CDN in a Box
-- Documentation
-- Grove
-- Traffic Control Client <!-- Please specify which; e.g. 'Python', 'Go', 'Java' -->
+<!-- Please delete all components from this list that are NOT affected by this Pull Request.
+Feel free to add the name of a tool or script that is affected but not on the list.
+-->
+- Documentation <!-- If this Pull Request does NOT affect documentation, please explain why. -->
Review comment:
We should get rid of this comment -- it's restated below.
##########
File path: PULL_REQUEST_TEMPLATE.md
##########
@@ -1,104 +1,59 @@
<!--
************ STOP!! ************
If this Pull Request is intended to fix a security vulnerability, DO NOT submit it! Instead, contact
-the Apache Software Foundation Security Team at security@trafficcontrol.apache.org and follow the
-guidelines at https://www.apache.org/security/ regarding vulnerability disclosure.
+the Apache Traffic Control Security Team at security@trafficcontrol.apache.org and follow the
+guidelines at https://apache.org/security regarding vulnerability disclosure.
-->
## What does this PR (Pull Request) do?
-<!-- Explain the changes you made here. If this fixes an Issue, identify it by
-replacing the text in the checkbox item with the Issue number e.g.
+- [ ] This PR fixes #REPLACE_ME
+<!-- Or you can say
+- [x] This PR is not related to any Issue
-- [x] This PR fixes #9001 OR is not related to any Issue
-
-^ This will automatically close Issue number 9001 when the Pull Request is
-merged (The '#' is important).
-
-Be sure you check the box properly, see the "The following criteria are ALL
-met by this PR" section for details.
--->
-
-- [ ] This PR fixes #REPLACE_ME OR is not related to any Issue <!-- You can check for an issue here: https://github.com/apache/trafficcontrol/issues -->
+A description of your PR goes here ↓ -->
## Which Traffic Control components are affected by this PR?
-<!-- Please delete all components from this list that are NOT affected by this
-Pull Request. Also, feel free to add the name of a tool or script that is
-affected but not on the list.
-
-Additionally, if this Pull Request does NOT affect documentation, please
-explain why documentation is not required. -->
-
-- CDN in a Box
-- Documentation
-- Grove
-- Traffic Control Client <!-- Please specify which; e.g. 'Python', 'Go', 'Java' -->
+<!-- Please delete all components from this list that are NOT affected by this Pull Request.
+Feel free to add the name of a tool or script that is affected but not on the list.
+-->
+- Documentation <!-- If this Pull Request does NOT affect documentation, please explain why. -->
+- Traffic Control Cache Config (T3C)
+- Traffic Control Client <!-- Please specify which (Python, Go, or Java) -->
- Traffic Monitor
- Traffic Ops
-- Traffic Ops ORT
- Traffic Portal
- Traffic Router
- Traffic Stats
-- Traffic Vault
-- CI tests
+- Grove
+- CDN in a Box
+- Automation <!-- Please specify which (GitHub Actions, Docker images, Ansible Roles, etc.) -->
+- unknown
## What is the best way to verify this PR?
-<!-- Please include here ALL the steps necessary to test your Pull Request. If
-it includes tests (and most should), outline here the steps needed to run the
-tests. If not, lay out the manual testing procedure and please explain why
-tests are unnecessary for this Pull Request. -->
+<!-- Please include here ALL the steps necessary to test your Pull Request.
Review comment:
it might flow better if Pull Request is abbreviated to PR throughout
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request #6055: Shorten and clarify PR and Issue templates
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #6055:
URL: https://github.com/apache/trafficcontrol/pull/6055#discussion_r675853939
##########
File path: PULL_REQUEST_TEMPLATE.md
##########
@@ -1,104 +1,59 @@
<!--
************ STOP!! ************
If this Pull Request is intended to fix a security vulnerability, DO NOT submit it! Instead, contact
-the Apache Software Foundation Security Team at security@trafficcontrol.apache.org and follow the
-guidelines at https://www.apache.org/security/ regarding vulnerability disclosure.
+the Apache Traffic Control Security Team at security@trafficcontrol.apache.org and follow the
+guidelines at https://apache.org/security regarding vulnerability disclosure.
-->
## What does this PR (Pull Request) do?
-<!-- Explain the changes you made here. If this fixes an Issue, identify it by
-replacing the text in the checkbox item with the Issue number e.g.
+- [ ] This PR fixes #REPLACE_ME
+<!-- Or you can say
+- [x] This PR is not related to any Issue
-- [x] This PR fixes #9001 OR is not related to any Issue
-
-^ This will automatically close Issue number 9001 when the Pull Request is
-merged (The '#' is important).
-
-Be sure you check the box properly, see the "The following criteria are ALL
-met by this PR" section for details.
--->
-
-- [ ] This PR fixes #REPLACE_ME OR is not related to any Issue <!-- You can check for an issue here: https://github.com/apache/trafficcontrol/issues -->
+A description of your PR goes here ↓ -->
## Which Traffic Control components are affected by this PR?
-<!-- Please delete all components from this list that are NOT affected by this
-Pull Request. Also, feel free to add the name of a tool or script that is
-affected but not on the list.
-
-Additionally, if this Pull Request does NOT affect documentation, please
-explain why documentation is not required. -->
-
-- CDN in a Box
-- Documentation
-- Grove
-- Traffic Control Client <!-- Please specify which; e.g. 'Python', 'Go', 'Java' -->
+<!-- Please delete all components from this list that are NOT affected by this Pull Request.
+Feel free to add the name of a tool or script that is affected but not on the list.
+-->
+- Documentation <!-- If this Pull Request does NOT affect documentation, please explain why. -->
Review comment:
Comment removed in 2bdd674a26
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request #6055: Shorten and clarify PR and Issue templates
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #6055:
URL: https://github.com/apache/trafficcontrol/pull/6055#discussion_r675855223
##########
File path: PULL_REQUEST_TEMPLATE.md
##########
@@ -1,104 +1,59 @@
<!--
************ STOP!! ************
If this Pull Request is intended to fix a security vulnerability, DO NOT submit it! Instead, contact
-the Apache Software Foundation Security Team at security@trafficcontrol.apache.org and follow the
-guidelines at https://www.apache.org/security/ regarding vulnerability disclosure.
+the Apache Traffic Control Security Team at security@trafficcontrol.apache.org and follow the
+guidelines at https://apache.org/security regarding vulnerability disclosure.
-->
## What does this PR (Pull Request) do?
-<!-- Explain the changes you made here. If this fixes an Issue, identify it by
-replacing the text in the checkbox item with the Issue number e.g.
+- [ ] This PR fixes #REPLACE_ME
+<!-- Or you can say
+- [x] This PR is not related to any Issue
-- [x] This PR fixes #9001 OR is not related to any Issue
-
-^ This will automatically close Issue number 9001 when the Pull Request is
-merged (The '#' is important).
-
-Be sure you check the box properly, see the "The following criteria are ALL
-met by this PR" section for details.
--->
-
-- [ ] This PR fixes #REPLACE_ME OR is not related to any Issue <!-- You can check for an issue here: https://github.com/apache/trafficcontrol/issues -->
+A description of your PR goes here ↓ -->
## Which Traffic Control components are affected by this PR?
-<!-- Please delete all components from this list that are NOT affected by this
-Pull Request. Also, feel free to add the name of a tool or script that is
-affected but not on the list.
-
-Additionally, if this Pull Request does NOT affect documentation, please
-explain why documentation is not required. -->
-
-- CDN in a Box
-- Documentation
-- Grove
-- Traffic Control Client <!-- Please specify which; e.g. 'Python', 'Go', 'Java' -->
+<!-- Please delete all components from this list that are NOT affected by this Pull Request.
+Feel free to add the name of a tool or script that is affected but not on the list.
+-->
+- Documentation <!-- If this Pull Request does NOT affect documentation, please explain why. -->
+- Traffic Control Cache Config (T3C)
+- Traffic Control Client <!-- Please specify which (Python, Go, or Java) -->
- Traffic Monitor
- Traffic Ops
-- Traffic Ops ORT
- Traffic Portal
- Traffic Router
- Traffic Stats
-- Traffic Vault
-- CI tests
+- Grove
+- CDN in a Box
+- Automation <!-- Please specify which (GitHub Actions, Docker images, Ansible Roles, etc.) -->
+- unknown
## What is the best way to verify this PR?
-<!-- Please include here ALL the steps necessary to test your Pull Request. If
-it includes tests (and most should), outline here the steps needed to run the
-tests. If not, lay out the manual testing procedure and please explain why
-tests are unnecessary for this Pull Request. -->
+<!-- Please include here ALL the steps necessary to test your Pull Request.
+If your PR includes tests (and most should), provide the steps needed to run the tests.
+If not, please provide step-by-step instructions to test the PR manually and explain why your PR does not need tests. -->
-## If this is a bug fix, what versions of Traffic Control are affected?
-<!-- If this PR fixes a bug, please list here all of the affected versions - to
-the best of your knowledge. It's also pretty helpful to include a commit hash
-of where 'master' is at the time this PR is opened (if it affects master),
-because what 'master' means will change over time. For example, if this PR
-fixes a bug that's present in master (at commit hash '1df853c8'), in v4.0.0,
-and in the current 4.0.1 Release candidate (e.g. RC1), then this list would
-look like:
-- master (1df853c8)
-- 4.0.0
-- 4.0.1 (RC1)
-
-If you don't know what other versions might have this bug, AND don't know how
-to find the commit hash of 'master', then feel free to leave this section
-blank (or, preferably, delete it entirely).
+## If this is a bugfix, which Traffic Control versions contained the bug?
+<!-- Delete this section if the PR is not a bugfix, or if the bug is only in the master branch.
+Examples:
+- 5.1.2
+- 5.1.3 (RC1)
-->
## The following criteria are ALL met by this PR
-<!-- Check the boxes to signify that the associated statement is true. To
-"check a box", replace the space inside of the square brackets with an 'x'.
-e.g.
-
-- [ x] <- Wrong
-- [x ] <- Wrong
-- [] <- Wrong
-- [*] <- Wrong
-- [x] <- Correct!
-
--->
-
-- [ ] This PR includes tests OR I have explained why tests are unnecessary
-- [ ] This PR includes documentation OR I have explained why documentation is unnecessary
-- [ ] This PR includes an update to CHANGELOG.md OR such an update is not necessary
-- [ ] This PR includes any and all required license headers
-- [ ] This PR **DOES NOT FIX A SERIOUS SECURITY VULNERABILITY** (see [the Apache Software Foundation's security guidelines](https://www.apache.org/security/) for details)
-
-
-## Additional Information
-<!-- If you would like to include any additional information on the PR for
-potential reviewers please put it here.
-
-Some examples of this would be:
-
-- Before and after screenshots/gifs of the Traffic Portal if it is affected
-- Links to other dependent Pull Requests
-- References to relevant context (e.g. new/updates to dependent libraries,
-mailing list records, blueprints)
-
-Feel free to leave this section blank (or, preferably, delete it entirely).
--->
+<!-- Check each box to signify that the associated statement is true. For example:
Review comment:
Checkboxes checked in c8885b4d9e
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] mitchell852 commented on a change in pull request #6055: Shorten and clarify PR and Issue templates
Posted by GitBox <gi...@apache.org>.
mitchell852 commented on a change in pull request #6055:
URL: https://github.com/apache/trafficcontrol/pull/6055#discussion_r680204031
##########
File path: .github/ISSUE_TEMPLATE/2-feature-request.md
##########
@@ -1,79 +1,62 @@
---
+# 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
+#
+# http://www.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.
+#
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 security@trafficcontrol.apache.org and follow the
-guidelines at https://www.apache.org/security/ regarding vulnerability disclosure.
+guidelines at https://apache.org/security regarding vulnerability disclosure.
- For *SUPPORT QUESTIONS*, use the #traffic-control channel on the ASF slack (https://s.apache.org/slack-invite)
-or Traffic Control mailing lists (https://trafficcontrol.apache.org/mailing_lists).
-- Before submitting, please **SEARCH GITHUB** for a similar issue or PR.
+or the Traffic Control Users mailing list (send an email to users-subscribe@trafficcontrol.apache.org to subscribe).
+- Before submitting, please **SEARCH GITHUB** for a similar issue or PR
+ * https://github.com/apache/trafficcontrol/issues
+ * https://github.com/apache/trafficcontrol/pulls
-->
## 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)-->
+<!-- Do not submit a security vulnerability here - see above security vulnerability info -->
+- [x] new feature / enhancement request
+<!-- 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
+- Traffic Control Cache Config (T3C)
+- Traffic Control Client <!-- Please specify which (Python, Go, or Java) -->
+- Traffic Monitor
+- Traffic Ops
+- Traffic Portal
+- Traffic Router
+- Traffic Stats
+- Grove
+- Documentation
+- CDN in a Box
+- Automation (GitHub Actions, Ansible Roles)
+- unknown
## Current behavior:
Review comment:
i think the diff between improvement and new feature was supposed to be:
improvement: you can do this already but it's really painful so it needs improved
new feature: you can't do this at all
but i have no problem combining them. in the issue template and the labels.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] rawlinp commented on a change in pull request #6055: Shorten and clarify PR and Issue templates
Posted by GitBox <gi...@apache.org>.
rawlinp commented on a change in pull request #6055:
URL: https://github.com/apache/trafficcontrol/pull/6055#discussion_r678448147
##########
File path: .github/ISSUE_TEMPLATE/2-feature-request.md
##########
@@ -1,79 +1,62 @@
---
+# 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
+#
+# http://www.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.
+#
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 security@trafficcontrol.apache.org and follow the
-guidelines at https://www.apache.org/security/ regarding vulnerability disclosure.
+guidelines at https://apache.org/security regarding vulnerability disclosure.
- For *SUPPORT QUESTIONS*, use the #traffic-control channel on the ASF slack (https://s.apache.org/slack-invite)
-or Traffic Control mailing lists (https://trafficcontrol.apache.org/mailing_lists).
-- Before submitting, please **SEARCH GITHUB** for a similar issue or PR.
+or the Traffic Control Users mailing list (send an email to users-subscribe@trafficcontrol.apache.org to subscribe).
+- Before submitting, please **SEARCH GITHUB** for a similar issue or PR
+ * https://github.com/apache/trafficcontrol/issues
+ * https://github.com/apache/trafficcontrol/pulls
-->
## 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)-->
+<!-- Do not submit a security vulnerability here - see above security vulnerability info -->
+- [x] new feature / enhancement request
+<!-- 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
+- Traffic Control Cache Config (T3C)
+- Traffic Control Client <!-- Please specify which (Python, Go, or Java) -->
+- Traffic Monitor
+- Traffic Ops
+- Traffic Portal
+- Traffic Router
+- Traffic Stats
+- Grove
+- Documentation
+- CDN in a Box
+- Automation (GitHub Actions, Ansible Roles)
+- unknown
## Current behavior:
Review comment:
Yeah, maybe combine it into this?
```
## Description
<!-- Describe how the current ATC features are insufficient and how this new feature would improve Traffic Control -->
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org