Skip to content

Commit

Permalink
docs: add bug report and feature request templates
Browse files Browse the repository at this point in the history
  • Loading branch information
alex-courtis committed Apr 1, 2024
1 parent 330741c commit 3b2f0d0
Show file tree
Hide file tree
Showing 5 changed files with 72 additions and 9 deletions.
42 changes: 42 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: Bug Report
description: Report a problem with wideriver
labels: [bug]
body:
- type: textarea
attributes:
label: "Expected behavior"
description: "Describe the behavior you expect:"
validations:
required: true
- type: textarea
attributes:
label: "Actual behavior"
description: "Describe the actual behaviour. You can optionally attach screenshots or videos. [grim](https://git.sr.ht/~emersion/grim/) and [wf-recorder](https://github.com/ammen99/wf-recorder) may be useful."
validations:
required: true
- type: textarea
attributes:
label: "Steps to reproduce"
description: "Steps to reproduce using the minimal config provided below."
validations:
required: true
- type: textarea
attributes:
label: "river version"
description: "Output of `river -version`"
render: text
validations:
required: true
- type: input
attributes:
label: "wideriver version"
description: "Output of `wideriver --version`"
validations:
required: true
- type: input
attributes:
label: "Startup logs"
description: "Logs up to \"wideriver started\" are useful as they show the startup arguments."
validations:
required: true

21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: Feature Request
description: Suggest new wideriver functionality
labels: [feature]
body:
- type: textarea
attributes:
label: "Missing behavior"
description: "Describe the behavior that is not available."
validations:
required: true
- type: textarea
attributes:
label: "Desired solution"
description: "Describe the solution you'd like."
validations:
required: true
- type: textarea
attributes:
label: "Ideas"
description: "A \"sketch\" of the solution. You could draft an image or `wideriver` arguments or `riverctl` commands."

6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -427,15 +427,15 @@ This may be resolved with a river enhancement: [\#1004](https://github.com/river

### Problems

Please raise a [Bug Report](https://github.com/alex-courtis/wideriver/issues/new/choose)
Please raise a [Bug Report](https://github.com/alex-courtis/wideriver/issues/new?assignees=&labels=bug&projects=&template=bug_report.yml)

### Ideas

Please create a [Feature Request](https://github.com/alex-courtis/wideriver/issues/new/choose)
Please create a [Feature Request](https://github.com/alex-courtis/wideriver/issues/new?assignees=&labels=feature&projects=&template=feature_request.yml)

### Questions or Discussions

Please raise an [Issue](https://github.com/alex-courtis/wideriver/issues/new/choose)
Please raise an [Issue](https://github.com/alex-courtis/wideriver/issues/new)

### Contributions

Expand Down
6 changes: 3 additions & 3 deletions doc/templ/40.man.readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,15 +93,15 @@ This may be resolved with a river enhancement: [#1004](https://github.com/riverw

### Problems

Please raise a [Bug Report](https://github.com/alex-courtis/wideriver/issues/new/choose)
Please raise a [Bug Report](https://github.com/alex-courtis/wideriver/issues/new?assignees=&labels=bug&projects=&template=bug_report.yml)

### Ideas

Please create a [Feature Request](https://github.com/alex-courtis/wideriver/issues/new/choose)
Please create a [Feature Request](https://github.com/alex-courtis/wideriver/issues/new?assignees=&labels=feature&projects=&template=feature_request.yml)

### Questions or Discussions

Please raise an [Issue](https://github.com/alex-courtis/wideriver/issues/new/choose)
Please raise an [Issue](https://github.com/alex-courtis/wideriver/issues/new)

### Contributions

Expand Down
6 changes: 3 additions & 3 deletions man/wideriver.1
Original file line number Diff line number Diff line change
Expand Up @@ -446,13 +446,13 @@ This may be resolved with a river enhancement: #1004 (https://github.com/riverwm
.SH ISSUES
.SS Problems
.PP
Please raise a Bug Report (https://github.com/alex-courtis/wideriver/issues/new/choose)
Please raise a Bug Report (https://github.com/alex-courtis/wideriver/issues/new?assignees=&labels=bug&projects=&template=bug_report.yml)
.SS Ideas
.PP
Please create a Feature Request (https://github.com/alex-courtis/wideriver/issues/new/choose)
Please create a Feature Request (https://github.com/alex-courtis/wideriver/issues/new?assignees=&labels=feature&projects=&template=feature_request.yml)
.SS Questions or Discussions
.PP
Please raise an Issue (https://github.com/alex-courtis/wideriver/issues/new/choose)
Please raise an Issue (https://github.com/alex-courtis/wideriver/issues/new)
.SS Contributions
.PP
CONTRIBUTING.md is most gratefully appreciated.
Expand Down

0 comments on commit 3b2f0d0

Please sign in to comment.