Skip to content

Commit 8fc94c6

Browse files
dguidoclaude
andcommitted
Reduce friction for bug reporting
- 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 <[email protected]>
1 parent 56cd17b commit 8fc94c6

File tree

5 files changed

+15
-25
lines changed

5 files changed

+15
-25
lines changed
Lines changed: 5 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,15 @@
11
---
22
name: Bug report
3-
about: Create a report to help us improve
4-
3+
about: Report a problem with Algo
54
---
65

7-
**Describe the bug**
8-
9-
A clear and concise description of what the bug is.
10-
11-
**To Reproduce**
12-
13-
Steps to reproduce the behavior:
14-
1. Do this..
15-
2. Do that..
16-
3. ..
17-
18-
**Expected behavior**
19-
20-
A clear and concise description of what you expected to happen.
21-
22-
**Additional context**
6+
**What happened?**
237

24-
Add any other context about the problem here.
258

26-
**Full log**
9+
**Environment** (cloud provider, OS, WireGuard or IPsec)
2710

28-
<!--- Put here the FULL LOG after you run the ./algo script below -->
2911

12+
**Output**
3013
```
31-
PUT THE OUTPUT HERE
14+
Paste any error messages or relevant output here
3215
```

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
blank_issues_enabled: true
3+
contact_links:
4+
- name: Troubleshooting Guide
5+
url: https://trailofbits.github.io/algo/troubleshooting.html
6+
about: Check common issues and solutions before filing

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
### Filing New Issues
22

3-
* 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)
3+
* 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
44
* Algo automatically installs dependencies with uv - no manual setup required
55
* We support modern clients: macOS 12+, iOS 15+, Windows 11+, Ubuntu 22.04+, etc.
66
* Supported cloud providers: DigitalOcean, AWS, Azure, GCP, Vultr, Hetzner, Linode, OpenStack, CloudStack

config.cfg

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -201,8 +201,9 @@ cloud_providers:
201201

202202
fail_hint:
203203
- Sorry, but something went wrong!
204-
- Please check the troubleshooting guide.
204+
- Check troubleshooting for common fixes, or file an issue if you found a bug.
205205
- https://trailofbits.github.io/algo/troubleshooting.html
206+
- https://github.com/trailofbits/algo/issues/new
206207

207208
booleans_map:
208209
Y: true

docs/troubleshooting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -517,4 +517,4 @@ Get-WinEvent -LogName "Microsoft-Windows-VPN-Client/Operational" -MaxEvents 50
517517

518518
## I have a problem not covered here
519519

520-
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).
520+
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.

0 commit comments

Comments
 (0)