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 new file mode 100644 index 000000000..dc408c02f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,2 @@ +# Disable blank issues for non-maintainers. +blank_issues_enabled: false 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..8f532b801 --- /dev/null +++ b/ISSUES.md @@ -0,0 +1,34 @@ +
+

CLI Issues

+

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

+
+ +## 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 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 +- 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..5c6e041d7 100644 --- a/README.md +++ b/README.md @@ -18,8 +18,10 @@ - [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) +- [Issues](https://github.com/fastly/cli/blob/main/ISSUES.md) - [Documentation](https://github.com/fastly/cli/blob/main/DOCUMENTATION.md) + ## Environment Variables | Variable | Description |