Skip to content

Commit

Permalink
ISSUE_TEMPLATE: Adjust wording, and add more pointers to lists
Browse files Browse the repository at this point in the history
  • Loading branch information
gdt committed Feb 2, 2025
1 parent ddf08c4 commit debe4c1
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 9 deletions.
7 changes: 7 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: Asking for Help
url: https://github.com/bcpierce00/unison/wiki/Mailing-Lists
about: Please direct questions the unison-users@ list, or unison-hackers@ if reading source code is helpful.
- name: Feature Requests (not fully worked out)
url: https://github.com/bcpierce00/unison/wiki/Mailing-Lists
about: Please bring up feature requests that are not fully designed on a mailing list.
15 changes: 11 additions & 4 deletions .github/ISSUE_TEMPLATE/defect.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
name: Defect
name: Defect Report
about: Create an issue that argues that there is a bug in unison
title: ''
labels: ''
labels: defect
assignees: ''
---

Expand All @@ -21,7 +21,7 @@ I have thoroughly read the [Reporting Bugs and Feature Requests](https://github.

# Meta

Bug reports must be minimal, as described in the wiki page.
Bug reports must be about a minimized configuration, as described in the wiki page.

People filing bug reports will be expected to follow up and perhaps
test proposed fixes.
Expand All @@ -37,6 +37,13 @@ test proposed fixes.

# Reproduction Recipe

Describe how to reproduce the bug
[Describe how to reproduce the bug. This must be the smallest
configuration you can find that exhibits the bug, and you should
include the largest working configuration also. Generally this means
local sync, TUI, no watcher, unless e.g. the bug is phrased as
"Without the watcher, behavior is correct, but on adding
fsmonitor-foo, ....".]

# Expected behavior vs actual behavior

[Describe the actual behavior. Argue that the behavior is incorrect.]
9 changes: 4 additions & 5 deletions .github/ISSUE_TEMPLATE/feature.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
name: Feature
about: Create a well-thought out feature request
name: Fully-designed Feature Request
about: Create a fully-specified feature request
title: ''
labels: ''
labels: enhancement
assignees: ''
---

Expand All @@ -14,7 +14,7 @@ thoroughly and follow the guidelines it expresses:
https://github.com/bcpierce00/unison/wiki/Reporting-Bugs-and-Feature-Requests

If your feature request is not fully formed, please post on
unison-hackers@ instead.
unison-users@ or unison-hackers@ instead.

Pleaes delete the following dashed line and the text above it, leaving the
statement that you have read the wiki page.
Expand Down Expand Up @@ -54,4 +54,3 @@ Discuss problems that will arise and how they should be handled.
Discuss the tradeoff of complexity in the code base and documentation
vs the benefit to users. Generally, proposed features should be of
fairly broad interest.

0 comments on commit debe4c1

Please sign in to comment.