Fix issue templates (#1267)

* change from md to yml * fix yml problems * fix quotes * make subheadings one level higher * small tweaks
OSOceanAcoustics · Feb 27, 2024 · ce50400 · ce50400
1 parent 8a818ea
commit ce50400
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 21 deletions.
diff --git a/.github/ISSUE_TEMPLATE/conversion_error.md → .github/ISSUE_TEMPLATE/conversion_error.yml b/.github/ISSUE_TEMPLATE/conversion_error.md → .github/ISSUE_TEMPLATE/conversion_error.yml
@@ -15,7 +15,7 @@ body:
       required: true
   - type: markdown
     attributes:
-      value: "### Computing environment"
+      value: "## Computing environment"
   - type: input
     attributes:
       label: Echopype version
@@ -36,10 +36,10 @@ body:
       required: true
   - type: markdown
     attributes:
-      value: "### Minimum example and error messages"
+      value: "## Minimum example and error messages"
   - type: textarea
-    id: logs
     attributes:
+      label: Minimal code example
       description: Provide a minimum code snippet that reproduces your problem
       placeholder: |
         The following code reproduces the errors I encountered:
@@ -49,7 +49,6 @@ body:
     validations:
       required: true
   - type: textarea
-    id: error_msg
     attributes:
       label: Error message printouts
       description: |
@@ -59,28 +58,28 @@ body:
     validations:
       required: true
   - type: textarea
-    id: example_data
-    description: |
-      An example file that allow reproducing the problem.
-      Smaller files are strongly preferred (e.g., <25MB for AZFP and EK60, <100MB for EK80).
-    placeholder: |
-      This is a link to an example raw file from the XXX echosounder: SOME_ONLINE_LOCATION.
+    attributes:
+      label: Example data
+      description: |
+        An example file that allow reproducing the problem.
+        Smaller files are strongly preferred (e.g., <25MB for AZFP and EK60, <100MB for EK80).
+      placeholder: "This is a link to an example raw file from the XXX echosounder: SOME_ONLINE_LOCATION."
     validations:
       required: true
   - type: markdown
     attributes:
-      value: "### Troubleshooting"
+      value: "## Troubleshooting"
   - type: textarea
     attributes:
       label: Related existing issues or PRs
       description: |
-        Take a look at the current [issues](https://github.com/OSOceanAcoustics/echopype/issues) and [PRs](https://github.com/OSOceanAcoustics/echopype/pulls) |
-        and link anything related here.
-      placeholder: This topic is related to #XXX; or: I have not seen related issues/PRs
+        Take a look at the current [issues](https://github.com/OSOceanAcoustics/echopype/issues) and [PRs](https://github.com/OSOceanAcoustics/echopype/pulls) and link anything related here.
+      placeholder: "This topic is related to #XXX; or: I have not seen related issues/PRs"
     validations:
       required: true
   - type: textarea
     attributes:
+      label: Troubleshooting steps
       description: Explain any steps that you have taken to identify the cause of conversion error
     validations:
-      false
+      required: false
diff --git a/.github/ISSUE_TEMPLATE/gsoc24.md → .github/ISSUE_TEMPLATE/gsoc24.yml b/.github/ISSUE_TEMPLATE/gsoc24.md → .github/ISSUE_TEMPLATE/gsoc24.yml
@@ -10,8 +10,7 @@ body:
     attributes:
       label: Discussion topic
       description: |
-        What question do you have?
-        What idea do you want to propose?
+        What question do you have? What idea do you want to propose?
         Please raise only one topic in each issue.
       placeholder: I am wondering about ...
     validations:
@@ -20,9 +19,7 @@ body:
     attributes:
       label: Related existing issues or PRs
       description: |
-        Take a look at the current [issues](https://github.com/OSOceanAcoustics/echopype/issues)
-        and [PRs](https://github.com/OSOceanAcoustics/echopype/pulls)
-        and link anything related here.
-      placeholder: This topic is related to #XXX; or: I have not seen related issues/PRs
+        Take a look at the current [issues](https://github.com/OSOceanAcoustics/echopype/issues) and [PRs](https://github.com/OSOceanAcoustics/echopype/pulls) and link anything related here.
+      placeholder: "This topic is related to #XXX; or: I have not seen related issues/PRs"
     validations:
       required: true