Merge pull request #345 from symflower/issue-template-improve

Overhaul bug and feature request issue templates

.github/ISSUE_TEMPLATE/1-bug.yaml

@@ -1,4 +1,4 @@
-name: Bug Report
+name: Bug report
 description: Something is not working as expected.
 labels: ["bug"]
 
@@ -14,7 +14,7 @@ body:
     attributes:
       label: Brief Description
     validations:
-      required: false
+      required: true
 
   - type: textarea
     attributes:
@@ -26,7 +26,7 @@ body:
   - type: textarea
     attributes:
       label: Logs
-      description: "The (reduced) output of `eval-dev-quality`, or `<result-directory>/evaluation.log`."
+      description: "The (reduced) output of `eval-dev-quality`, or `${result directory}/evaluation.log`."
       render: shell
     validations:
       required: false
@@ -35,10 +35,10 @@ body:
     attributes:
       label: Additional Information
 
-  - type: textarea
+  - type: input
     attributes:
       label: Version
-      description: "Output of `eval-dev-quality version`."
+      description: "Output of `eval-dev-quality version` or commit revision."
       render: shell
     validations:
-      required: false
+      required: true

.github/ISSUE_TEMPLATE/2-enhancement.yaml

@@ -0,0 +1,25 @@
+name: Feature request
+description: Improving existing or adding new behavior.
+labels: ["enhancement"]
+
+body:
+  - type: checkboxes
+    attributes:
+      label: Please help us keep the number of duplicated issues small. We kindly ask you to add your input to the appropriate issue or PR in case your feature idea is already being tracked.
+      options:
+        - label: "I have searched the existing [feature requests](https://github.com/symflower/eval-dev-quality/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement), latest [roadmap](https://github.com/symflower/eval-dev-quality/issues?q=is%3Aopen+is%3Aissue+label%3Aroadmap) and [open pull requests](https://github.com/symflower/eval-dev-quality/pulls)."
+          required: true
+
+  - type: textarea
+    attributes:
+      label: Problem
+      description: Please describe the problem to be solved.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Solution (optional)
+      description: "Please outline your preferred solution. Describe how the solution looks for the end-user (i.e. using `eval-dev-quality`), and (if possible) a rough outline how the solution could be implemented from a technical perspective."
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/3-roadmap.md

@@ -1,5 +1,5 @@
 ---
-name: Roadmap Issue
+name: Roadmap planning
 about: Use this template for tracking release roadmaps.
 title: 'Roadmap for vXXXXX'
 labels: roadmap

Makefile

@@ -43,7 +43,7 @@ help: # Show this help message.
 	@grep -E '^[a-zA-Z-][a-zA-Z0-9.-]*?:.*?# (.+)' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?# "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
 .PHONY: help
 
-install: # [<Go package] - # Build and install everything, or only the specified package.
+install: # [Go package] - # Build and install everything, or only the specified package.
 	go install -v -ldflags="$(GO_LDFLAGS)" $(PACKAGE)
 .PHONY: install
 

scripts/evaluation/stats.sh

@@ -1,6 +1,6 @@
 #!/bin/bash
 
-# Usage: script.sh <evaluation-file> <meta-file>
+# Usage: script.sh ${evaluation file} ${meta file}
 
 # Check if csvkit is installed.
 if ! command -v csvsql &> /dev/null

scripts/max-score/run.sh

@@ -1,6 +1,6 @@
 #!/bin/bash
 
-# Usage: script.sh <evaluation-directory>
+# Usage: script.sh ${evaluation directory}
 
 echo "WRITE TESTS"
 echo "java:"