docs: add issue templates (#6)

* docs: add bug report and feature request templates

* docs: add bug report and feature request templates

.editorconfig

@@ -10,3 +10,6 @@ trim_trailing_whitespace = true
 [*.md]
 trim_trailing_whitespace = false
 
+[*.{yml,yaml}]
+indent_style = space
+indent_size = 2

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -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
+

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -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."
+

README.md

@@ -46,7 +46,8 @@ Tiling window manager for the [river](https://github.com/riverwm/river) wayland
   * [Name Does Not Always Update](#name-does-not-always-update)
 - [ISSUES](#issues)
   * [Problems](#problems)
-  * [Questions And Ideas](#questions-and-ideas)
+  * [Ideas](#ideas)
+  * [Questions or Discussions](#questions-or-discussions)
   * [Contributions](#contributions)
 
 <!-- tocstop -->
@@ -426,16 +427,15 @@ This may be resolved with a river enhancement: [\#1004](https://github.com/river
 
 ### Problems
 
-Please create an [issue](https://github.com/alex-courtis/wideriver/issues):
+Please raise a [Bug Report](https://github.com/alex-courtis/wideriver/issues/new?assignees=&labels=bug&projects=&template=bug_report.yml)
 
-- attach your log
-- add `river -version`
-- describe the behaviour
-- screenshots may be useful
+### Ideas
 
-### Questions And Ideas
+Please create a [Feature Request](https://github.com/alex-courtis/wideriver/issues/new?assignees=&labels=feature&projects=&template=feature_request.yml)
 
-Please create an [issue](https://github.com/alex-courtis/wideriver/issues).
+### Questions or Discussions
+
+Please raise an [Issue](https://github.com/alex-courtis/wideriver/issues/new)
 
 ### Contributions
 

doc/templ/40.man.readme.md

@@ -93,16 +93,15 @@ This may be resolved with a river enhancement: [#1004](https://github.com/riverw
 
 ### Problems
 
-Please create an [issue](https://github.com/alex-courtis/wideriver/issues):
+Please raise a [Bug Report](https://github.com/alex-courtis/wideriver/issues/new?assignees=&labels=bug&projects=&template=bug_report.yml)
 
-- attach your log
-- add `river -version`
-- describe the behaviour
-- screenshots may be useful
+### Ideas
 
-### Questions And Ideas
+Please create a [Feature Request](https://github.com/alex-courtis/wideriver/issues/new?assignees=&labels=feature&projects=&template=feature_request.yml)
 
-Please create an [issue](https://github.com/alex-courtis/wideriver/issues).
+### Questions or Discussions
+
+Please raise an [Issue](https://github.com/alex-courtis/wideriver/issues/new)
 
 ### Contributions
 

man/wideriver.1

@@ -15,7 +15,7 @@
 . ftr VB CB
 . ftr VBI CBI
 .\}
-.TH "WIDERIVER" "1" "2024/03/02" "wideriver" "User Manuals"
+.TH "WIDERIVER" "1" "2024/04/01" "wideriver" "User Manuals"
 .hy
 .SH NAME
 .PP
@@ -446,18 +446,13 @@ This may be resolved with a river enhancement: #1004 (https://github.com/riverwm
 .SH ISSUES
 .SS Problems
 .PP
-Please create an issue (https://github.com/alex-courtis/wideriver/issues):
-.IP \[bu] 2
-attach your log
-.IP \[bu] 2
-add \f[V]river -version\f[R]
-.IP \[bu] 2
-describe the behaviour
-.IP \[bu] 2
-screenshots may be useful
-.SS Questions And Ideas
+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?assignees=&labels=feature&projects=&template=feature_request.yml)
+.SS Questions or Discussions
 .PP
-Please create an issue (https://github.com/alex-courtis/wideriver/issues).
+Please raise an Issue (https://github.com/alex-courtis/wideriver/issues/new)
 .SS Contributions
 .PP
 CONTRIBUTING.md is most gratefully appreciated.