From 6b024fcf60b51a92ca82074d32d7ef7861e876ad Mon Sep 17 00:00:00 2001 From: Richard Carillo Date: Thu, 19 Mar 2026 13:10:40 -0400 Subject: [PATCH 1/4] config test --- .github/ISSUE_TEMPLATE/config.yml | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..22ac18adc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,20 @@ +blank_issues_enabled: false +contact_links: + - name: Read First - When to Open an Issue + url: https://github.com/fastly/cli/blob/main/CONTRIBUTING.md + about: >- + Please open an issue if you've found a bug, have a feature request, or need help with + unexpected behavior. For general questions, usage help, or discussions about Fastly + services (not CLI-specific), please use the resources below instead. + - name: Community Discussions & Questions + url: https://github.com/fastly/cli/discussions + about: Ask questions, share ideas, and discuss with the community - great for "how do I" questions + - name: CLI Documentation + url: https://developer.fastly.com/reference/cli/ + about: Check the official CLI documentation for usage examples and command reference + - name: Security Vulnerabilities + url: https://mailto:security@fastly.com + about: For security issues, please email security@fastly.com instead of opening a public issue + - name: Fastly Support (Customers) + url: https://support.fastly.com/ + about: Existing customers can contact Fastly Support for account-specific or service-related issues From d3716842fabef08e95279f370c1e526983be406c Mon Sep 17 00:00:00 2001 From: Richard Carillo Date: Thu, 19 Mar 2026 16:16:24 -0400 Subject: [PATCH 2/4] docs(issue-template): updated issue tempaltes to include best practices and when to route to support Added a ISSUES.md file with best practices around issue types and annotations to the current issues around when to reach out to support instead. --- .github/ISSUE_TEMPLATE/bug_report.md | 9 ++++++ .github/ISSUE_TEMPLATE/config.yml | 20 +------------ .github/ISSUE_TEMPLATE/feature_request.md | 9 ++++++ ISSUES.md | 34 +++++++++++++++++++++++ README.md | 1 + 5 files changed, 54 insertions(+), 19 deletions(-) create mode 100644 ISSUES.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 4765008ca..e9c2659a4 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -7,6 +7,15 @@ assignees: '' --- + + **Version** Please paste the output of `fastly version` here. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 22ac18adc..dc408c02f 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,20 +1,2 @@ +# Disable blank issues for non-maintainers. blank_issues_enabled: false -contact_links: - - name: Read First - When to Open an Issue - url: https://github.com/fastly/cli/blob/main/CONTRIBUTING.md - about: >- - Please open an issue if you've found a bug, have a feature request, or need help with - unexpected behavior. For general questions, usage help, or discussions about Fastly - services (not CLI-specific), please use the resources below instead. - - name: Community Discussions & Questions - url: https://github.com/fastly/cli/discussions - about: Ask questions, share ideas, and discuss with the community - great for "how do I" questions - - name: CLI Documentation - url: https://developer.fastly.com/reference/cli/ - about: Check the official CLI documentation for usage examples and command reference - - name: Security Vulnerabilities - url: https://mailto:security@fastly.com - about: For security issues, please email security@fastly.com instead of opening a public issue - - name: Fastly Support (Customers) - url: https://support.fastly.com/ - about: Existing customers can contact Fastly Support for account-specific or service-related issues diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index e0b5dfb74..19f7565d4 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -7,6 +7,15 @@ assignees: '' --- + + **Is your feature request related to a problem? Please describe.** A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] diff --git a/ISSUES.md b/ISSUES.md new file mode 100644 index 000000000..6c44e2893 --- /dev/null +++ b/ISSUES.md @@ -0,0 +1,34 @@ +
+

CLI Issues

+

Best practices for submitting an issue to the Fastly CLI respository.

+
+ +## Issue Type: Bug + +Issues related to the CLI behavior not working as intended. + +- The CLI crashes or exits with an unexpected error +- A command produces incorrect output or wrong results +- Commands or flags don't work as documented + +**Example:** "When I run `fastly service list --json`, malformed JSON is produced." + +## Issue Type: Feature Request + +Issues related to suggesting improvements to the CLI: + +- New commands or subcommands based on existing Fastly APIs +- Improved error messages or user experience +- Adding support for a third party integration + +**Example:** "Add a `fastly service version validate` command, which already exists in the Fastly API." + +## Fastly Support + +CLI behavior specific to your environement or service / account should be routed to the Fastly support team @ support.fastly.com or support@fastly.com. + +- A feature is missing from your account / service +- Partial content is returned that you may not have access to with your current Fastly account role +- My site is not loading after a configuration change + +**Example:** When running `fastly service vcl snippet create`, an error is thrown that the provided VCL is not valid diff --git a/README.md b/README.md index f5b215902..f50a91e90 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,7 @@ - [Development](https://github.com/fastly/cli/blob/main/DEVELOPMENT.md) - [Testing](https://github.com/fastly/cli/blob/main/TESTING.md) - [Documentation](https://github.com/fastly/cli/blob/main/DOCUMENTATION.md) +- [Issues](https://github.com/fastly/cli/blob/main/ISSUES.md) ## Environment Variables From 36c0e68e290620d8db09445b5e60b16975ec2405 Mon Sep 17 00:00:00 2001 From: Richard Carillo Date: Fri, 20 Mar 2026 08:55:08 -0400 Subject: [PATCH 3/4] fix typos --- ISSUES.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/ISSUES.md b/ISSUES.md index 6c44e2893..8f532b801 100644 --- a/ISSUES.md +++ b/ISSUES.md @@ -1,6 +1,6 @@

CLI Issues

-

Best practices for submitting an issue to the Fastly CLI respository.

+

Best practices for submitting an issue to the Fastly CLI repository.

## Issue Type: Bug @@ -25,7 +25,7 @@ Issues related to suggesting improvements to the CLI: ## Fastly Support -CLI behavior specific to your environement or service / account should be routed to the Fastly support team @ support.fastly.com or support@fastly.com. +CLI behavior specific to your environment or service / account should be routed to the Fastly support team @ support.fastly.com or support@fastly.com. - A feature is missing from your account / service - Partial content is returned that you may not have access to with your current Fastly account role From 719f911174eb7aaad0d541e2f5e3b3135a6cf2a6 Mon Sep 17 00:00:00 2001 From: Richard Carillo Date: Fri, 20 Mar 2026 12:59:49 -0400 Subject: [PATCH 4/4] bump test --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f50a91e90..5c6e041d7 100644 --- a/README.md +++ b/README.md @@ -18,8 +18,9 @@ - [Commands](https://www.fastly.com/documentation/reference/cli#command-groups) - [Development](https://github.com/fastly/cli/blob/main/DEVELOPMENT.md) - [Testing](https://github.com/fastly/cli/blob/main/TESTING.md) -- [Documentation](https://github.com/fastly/cli/blob/main/DOCUMENTATION.md) - [Issues](https://github.com/fastly/cli/blob/main/ISSUES.md) +- [Documentation](https://github.com/fastly/cli/blob/main/DOCUMENTATION.md) + ## Environment Variables