Skip to content

[CDTOOL-1299] Improve Issue Template Routing #1705

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rcaril wants to merge 6 commits into
base: main
Choose a base branch
from
Open

[CDTOOL-1299] Improve Issue Template Routing #1705

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
6b024fc
config test
rcaril Mar 19, 2026
d371684
docs(issue-template): updated issue tempaltes to include best practic…
rcaril Mar 19, 2026
36c0e68
fix typos
rcaril Mar 20, 2026
719f911
bump test
rcaril Mar 20, 2026
704ee74
Merge branch 'main' into rcaril/CDTOOL-1299-improve-issue-templates
rcaril Mar 23, 2026
2aaa4ef
Merge branch 'main' into rcaril/CDTOOL-1299-improve-issue-templates
rcaril Mar 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,15 @@ assignees: ''

---

<!-- Note: Queries specific to your environment or account configuration should be routed to our support
team @ https://support.fastly.com.

**Example:** When running `fastly service vcl snippet create`, an error is thrown that the provided
VCL is not valid

More details on submitting issues can be found here: https://github.com/fastly/cli/blob/main/ISSUES.md
-->

**Version**

Please paste the output of `fastly version` here.
Expand Down
2 changes: 2 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Disable blank issues for non-maintainers.
blank_issues_enabled: false
Copy link
Contributor Author

@rcaril rcaril Mar 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This forces users to chose one of the existing issue types, Bug or Feature Request.

Copy link
Contributor Author

@rcaril rcaril Mar 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maintainers however, will still be able to use the Blank issue type if needed.

9 changes: 9 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,15 @@ assignees: ''

---

<!-- Note: Queries specific to your environment or account configuration should be routed to our support
team @ https://support.fastly.com.

**Example:** When running `fastly service vcl snippet create`, an error is thrown that the provided
VCL is not valid

More details on submitting issues can be found here: https://github.com/fastly/cli/blob/main/ISSUES.md
-->

**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 [...]

Expand Down
34 changes: 34 additions & 0 deletions ISSUES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
<div align="center">
<h3 align="center">CLI Issues</h3>
Copy link
Contributor Author

@rcaril rcaril Mar 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am very open to suggestions on how this document should be organized and formatted. Some of these examples may not be perfect - so please feel free to suggest improvements there as well.

<p align="center">Best practices for submitting an issue to the Fastly CLI repository.</p>
</div>

## Issue Type: Bug
Copy link
Contributor

@kpfleming kpfleming Mar 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are two other aspects I'd like to try to consider here:

  1. If a customer opens an issue here, but troubleshooting will require details that they aren't comfortable disclosing in public (even just SIDs), then they will also have to open a support ticket, and that's extra work/complication for everyone. A statement indicating that a bug report opened here will require troubleshooting to be done in that bug report, in public may effectively deter someone from opening a bug report instead of a support ticket.

  2. If a customer chooses to open a bug report or feature request here, they should not also open a support ticket for the same topic (and especially not open a support ticket which says "we asked a new feature here .... with a link to the issue". Again that just causes extra work and complications for everyone.

In other words, my personal preference would be to (as gently as possible) discourage customers from opening bug reports or feature requests in the public repositories at all, unless it is very clear to them that they will be comfortable with the discussion occurring in public and that the response time for public issues will be somewhat longer than for private support tickets.

Copy link
Contributor Author

@rcaril rcaril Mar 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Got it - it sounds like we'll be wanting to add this verbiage to both the issue templates as well as the ISSUES.md file then.


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
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down
Loading