Skip to content

Commit f2730b1

Browse files
authored
[CDTOOL-1299] Improve Issue Template Routing (#1705)
### Change summary This PR adds support docs and notes to existing templates clarifying when to reach out to support and general best practices around issue submitting. All Submissions: * [x] Have you followed the guidelines in our Contributing document? * [x] Have you checked to ensure there aren't other open [Pull Requests](https://github.com/fastly/cli/pulls) for the same update/change? <!-- You can erase any parts of this template not applicable to your Pull Request. --> ### User Impact Users no longer have access to the "Blank Issue" option.
1 parent bee7ac6 commit f2730b1

5 files changed

Lines changed: 59 additions & 0 deletions

File tree

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,17 @@ assignees: ''
77

88
---
99

10+
<!--
11+
**Note**: Please keep in mind that if your issue requires troubleshooting that will require any details that you aren't comfortable disclosing in this public forum (such as service IDs), you will need to open a Fastly support ticket instead: https://support.fastly.com.
12+
13+
Bug reports opened here:
14+
- Do not have an SLA
15+
- Should not be a duplicate of an existing support ticket that you have already created, or vice versa
16+
- May take longer to solve compared to our dedicated support team
17+
18+
More details on submitting issues can be found here: https://github.com/fastly/cli/blob/main/ISSUES.md
19+
-->
20+
1021
**Version**
1122

1223
Please paste the output of `fastly version` here.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Disable blank issues for non-maintainers.
2+
blank_issues_enabled: false

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,16 @@ assignees: ''
77

88
---
99

10+
<!--
11+
**Note**: Please keep in mind that if your feature request discusses any details that you aren't comfortable disclosing in this public forum (such as service IDs), you will need to open a Fastly support ticket instead: https://support.fastly.com.
12+
13+
Feature requests opened here:
14+
- Do not have an SLA nor are guaranteed to be implemented
15+
- Should not be a duplicate of an existing support ticket that you have already created, or vice versa
16+
17+
More details on submitting issues can be found here: https://github.com/fastly/cli/blob/main/ISSUES.md
18+
-->
19+
1020
**Is your feature request related to a problem? Please describe.**
1121
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
1222

ISSUES.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
<div align="center">
2+
<h3 align="center">CLI Issues</h3>
3+
<p align="center">Best practices for submitting an issue to the Fastly CLI repository.</p>
4+
</div>
5+
6+
## Issue Type: Bug
7+
8+
Issues related to the CLI behavior not working as intended.
9+
10+
- The CLI crashes or exits with an unexpected error
11+
- A command produces incorrect output or wrong results
12+
- Commands or flags don't work as documented
13+
14+
**Example:** "When I run `fastly service list --json`, malformed JSON is produced."
15+
16+
## Issue Type: Feature Request
17+
18+
Issues related to suggesting improvements to the CLI:
19+
20+
- New commands or subcommands based on existing Fastly APIs
21+
- Improved error messages or user experience
22+
- Adding support for a third party integration
23+
24+
**Example:** "Add a `fastly service version validate` command, which already exists in the Fastly API."
25+
26+
## Fastly Support
27+
28+
CLI behavior specific to your environment or service / account should be routed to the Fastly support team @ support.fastly.com or support@fastly.com.
29+
30+
- A feature is missing from your account / service
31+
- Partial content is returned that you may not have access to with your current Fastly account role
32+
- My site is not loading after a configuration change
33+
34+
**Example:** When running `fastly service vcl snippet create`, an error is thrown that the provided VCL is not valid

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,10 @@
1818
- [Commands](https://www.fastly.com/documentation/reference/cli#command-groups)
1919
- [Development](https://github.com/fastly/cli/blob/main/DEVELOPMENT.md)
2020
- [Testing](https://github.com/fastly/cli/blob/main/TESTING.md)
21+
- [Issues](https://github.com/fastly/cli/blob/main/ISSUES.md)
2122
- [Documentation](https://github.com/fastly/cli/blob/main/DOCUMENTATION.md)
2223

24+
2325
## Environment Variables
2426

2527
| Variable | Description |

0 commit comments

Comments
 (0)