From 11e4dcae22b4c4db500de2d72024f70e801e2b99 Mon Sep 17 00:00:00 2001 From: Dan Guido Date: Fri, 28 Nov 2025 23:45:29 -0500 Subject: [PATCH] Reduce friction for bug reporting (#14911) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Update error message to present troubleshooting and issue filing equally - Remove dead GitHub Discussions link from troubleshooting page - Simplify bug report template from 6 sections to 3 - Add config.yml to show troubleshooting link in issue chooser - Lead CONTRIBUTING.md with "We welcome bug reports!" 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: Claude --- .github/ISSUE_TEMPLATE/bug_report.md | 27 +++++---------------------- .github/ISSUE_TEMPLATE/config.yml | 6 ++++++ CONTRIBUTING.md | 2 +- config.cfg | 3 ++- docs/troubleshooting.md | 2 +- 5 files changed, 15 insertions(+), 25 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index cd9b4c6a..62c424bf 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,32 +1,15 @@ --- name: Bug report -about: Create a report to help us improve - +about: Report a problem with Algo --- -**Describe the bug** +**What happened?** -A clear and concise description of what the bug is. -**To Reproduce** +**Environment** (cloud provider, OS, WireGuard or IPsec) -Steps to reproduce the behavior: -1. Do this.. -2. Do that.. -3. .. - -**Expected behavior** - -A clear and concise description of what you expected to happen. - -**Additional context** - -Add any other context about the problem here. - -**Full log** - - +**Output** ``` -PUT THE OUTPUT HERE +Paste any error messages or relevant output here ``` diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..bc31a5ed --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,6 @@ +--- +blank_issues_enabled: true +contact_links: + - name: Troubleshooting Guide + url: https://trailofbits.github.io/algo/troubleshooting.html + about: Check common issues and solutions before filing diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d1052fef..c273161c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ ### Filing New Issues -* Check that your issue is not already described in the [FAQ](docs/faq.md), [troubleshooting](docs/troubleshooting.md) docs, or an [existing issue](https://github.com/trailofbits/algo/issues) +* We welcome bug reports! Before filing, a quick check of the [FAQ](docs/faq.md) or [troubleshooting](docs/troubleshooting.md) docs might have your answer * Algo automatically installs dependencies with uv - no manual setup required * We support modern clients: macOS 12+, iOS 15+, Windows 11+, Ubuntu 22.04+, etc. * Supported cloud providers: DigitalOcean, AWS, Azure, GCP, Vultr, Hetzner, Linode, OpenStack, CloudStack diff --git a/config.cfg b/config.cfg index 3e43c1a4..798fe742 100644 --- a/config.cfg +++ b/config.cfg @@ -201,8 +201,9 @@ cloud_providers: fail_hint: - Sorry, but something went wrong! - - Please check the troubleshooting guide. + - Check troubleshooting for common fixes, or file an issue if you found a bug. - https://trailofbits.github.io/algo/troubleshooting.html + - https://github.com/trailofbits/algo/issues/new booleans_map: Y: true diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index 02d82f42..143a3f91 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -517,4 +517,4 @@ Get-WinEvent -LogName "Microsoft-Windows-VPN-Client/Operational" -MaxEvents 50 ## I have a problem not covered here -If you have an issue that you cannot solve with the guidance here, [create a new discussion](https://github.com/trailofbits/algo/discussions) and ask for help. If you think you found a new issue in Algo, [file an issue](https://github.com/trailofbits/algo/issues/new). +If you have an issue that you cannot solve with the guidance here, please [file an issue](https://github.com/trailofbits/algo/issues/new). We welcome bug reports and want to hear about problems you encounter.