Skip to content

Commit 861cf88

Browse files
committed
Improve the issue templates
1 parent 3c4426d commit 861cf88

File tree

2 files changed

+49
-42
lines changed

2 files changed

+49
-42
lines changed

.github/ISSUE_TEMPLATE/bugs.md

Lines changed: 25 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,65 +1,55 @@
11
---
2-
name: "\U0001F41E Issues"
3-
about: Bug reports
2+
name: "Bug Report"
3+
about: Report a bug you've encountered
44
title: ''
55
labels: ''
66
assignees: ''
77

88
---
99

10-
THE TRACKER IS DEDICATED TO KEEPING TRACK OF *BUGS*,
11-
preferably after they have been already discussed and confirmed to be reproducible.
10+
Thanks for taking the time to report a bug! Before filing, please note:
1211

13-
FOR ASSISTANCE, PLEASE CLOSE THIS FORM AND USE THE DISCUSSIONS SECTION INSTEAD:
14-
https://github.com/DNSCrypt/dnscrypt-proxy/discussions/categories/q-a
12+
**Need help or have a question?** The issue tracker is for confirmed, reproducible bugs. For assistance with installation, configuration, or general questions, please use our [Q&A Discussions](https://github.com/DNSCrypt/dnscrypt-proxy/discussions/categories/q-a) instead - you'll likely get a faster response there.
1513

16-
~~~
14+
---
1715

18-
Reported bugs must reproducible in the context described in the "Context" section.
16+
### Before submitting
1917

20-
Installation and configuration issues are not bugs, but individual assistance request.
18+
Please make sure:
2119

22-
Context: the LATEST version of `dnscrypt-proxy` (precompiled binaries downloaded from this repository) is correctly installed and configured on your system, but something doesn't seem to produce the expected result.
20+
- You're running the **latest version** of `dnscrypt-proxy` (precompiled binaries from this repository)
21+
- The software is correctly installed and configured
22+
- You can reliably reproduce the issue
2323

24-
If the bug is not trivial to reproduce on any platform, please include ALL the steps required to reliably duplicate it, on a vanilla, generic install of macOS, Windows, OpenBSD or Ubuntu Linux system, in their most current version.
24+
If the bug requires specific steps to reproduce, please include detailed instructions that would work on a fresh install of macOS, Windows, OpenBSD, or Ubuntu Linux.
2525

26-
If you don't have any clear understanding of the issue or can't enumerate the steps to reproduce it, open a discussion instead:
27-
https://github.com/DNSCrypt/dnscrypt-proxy/discussions
26+
Not sure if it's a bug? Start a [discussion](https://github.com/DNSCrypt/dnscrypt-proxy/discussions) first - we're happy to help figure it out.
2827

28+
---
2929

30-
## Output of the following commands:
30+
## Diagnostic output
3131

32-
./dnscrypt-proxy -version
32+
Please run these commands and paste the output:
3333

34+
```
35+
./dnscrypt-proxy -version
3436
./dnscrypt-proxy -check
35-
3637
./dnscrypt-proxy -resolve example.com
37-
38+
```
3839

3940
- [ ] Initially raised as discussion #...
4041

42+
## What's happening?
4143

44+
## When does this occur?
4245

43-
## *What* is affected by this bug?
44-
45-
46-
47-
## *When* does this occur?
48-
49-
50-
51-
## *Where* does it happen?
52-
53-
54-
55-
## *How* do we replicate the issue?
56-
<!-- Please list all the steps required to reliably replicate it, starting from a newly installed operating system -->
57-
58-
46+
## Where does it happen?
5947

60-
## Expected behavior (i.e. solution)
48+
## How do we replicate the issue?
6149

50+
<!-- Starting from a fresh OS install, what steps trigger this bug? -->
6251

52+
## Expected behavior
6353

64-
## Other Comments
54+
## Additional context
6555

Lines changed: 24 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,39 @@
11
---
2-
name: "🙋🏽 Planned changes"
3-
about: List of planned changes
2+
name: "Feature Request"
3+
about: Suggest an idea or improvement
44
title: ''
55
labels: ''
66
assignees: ''
77

88
---
99

10-
The starting point should be a discussion.
10+
Got an idea for improving dnscrypt-proxy? We'd love to hear it!
1111

12-
https://github.com/DNSCrypt/dnscrypt-proxy/discussions/
12+
### Start with a discussion
1313

14-
Suggestions may be raised as an "Ideas" discussion.
14+
The best way to propose a new feature is to start in [Discussions](https://github.com/DNSCrypt/dnscrypt-proxy/discussions/) under the "Ideas" category. This lets us:
1515

16-
We can then determine if the discussion needs to be escalated into a "planned change" or not.
16+
- Talk through the idea together
17+
- Get feedback from other users
18+
- Figure out the best approach
1719

18-
This will help us ensure that the issue tracker properly reflects ongoing or needed work on the project.
20+
Once we've discussed and agreed on a direction, we can convert it into a tracked issue here.
21+
22+
This helps keep the issue tracker focused on work that's ready to be done.
1923

2024
---
2125

2226
- [ ] Initially raised as discussion #...
27+
28+
## Summary
29+
30+
<!-- Brief description of your idea -->
31+
32+
## Why would this be useful?
33+
34+
<!-- What problem does it solve? Who would benefit? -->
35+
36+
## Possible implementation
37+
38+
<!-- Optional: any thoughts on how this could work? -->
39+

0 commit comments

Comments
 (0)