Skip to content

Commit 06ac084

Browse files
authored
Update issue templates to avoid line breaks in long paragraph (#3649)
1 parent 9d1a5ea commit 06ac084

File tree

3 files changed

+34
-22
lines changed

3 files changed

+34
-22
lines changed

.github/ISSUE_TEMPLATE/1-bug_report.yaml

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,30 @@
11
name: Bug report
2-
description: Report a problem/bug to help us improve
2+
description: Report a problem/bug to help us improve.
33
labels: bug
44
body:
55
- type: markdown
66
attributes:
7-
value: |
7+
value: >
88
Thanks for taking the time to fill out this bug report!
99
- type: textarea
1010
attributes:
1111
label: "Description of the problem"
12-
description: |
12+
description: >
1313
Please be as detailed as you can when describing an issue.
1414
The more information we have, the easier it will be for us to track this down.
1515
validations:
1616
required: true
1717
- type: textarea
1818
attributes:
1919
label: "Minimal Complete Verifiable Example"
20-
description: |
20+
description: >
2121
So that we can understand and fix the issue quickly and efficiently, please provide
2222
a minimal, self-contained copy-pastable example that demonstrates the issue.
23+
2324
For more details, check out:
2425
2526
- [Minimal Complete Verifiable Examples](https://stackoverflow.com/help/mcve)
27+
2628
- [Craft Minimal Bug Reports](https://matthewrocklin.com/minimal-bug-reports)
2729
2830
placeholder: "PASTE CODE HERE"
@@ -40,9 +42,11 @@ body:
4042
- type: textarea
4143
attributes:
4244
label: "System information"
43-
description: |
44-
Please paste the output of `python -c "import pygmt; pygmt.show_versions()"`
45-
If this command is not successful, please describe your operating system, how you installed PyGMT, how you installed GMT, and paste the full error message.
45+
description: >
46+
Please paste the output of `python -c "import pygmt; pygmt.show_versions()"`.
47+
48+
If this command is not successful, please describe your operating system,
49+
how you installed PyGMT, how you installed GMT, and paste the full error message.
4650
placeholder: "PASTE THE OUTPUT HERE"
4751
render: bash
4852
validations:

.github/ISSUE_TEMPLATE/2-feature_request.yaml

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,17 @@ body:
55
- type: textarea
66
attributes:
77
label: "Description of the desired feature"
8-
description: |
9-
Please be as detailed as you can in your description.
10-
If possible, include an example of how you would like to use this feature (even better if it's a code example).
8+
description: >
9+
Please be as detailed as you can in your description. If possible, include
10+
an example of how you would like to use this feature (even better if it's a code example).
1111
- type: dropdown
1212
id: help
1313
attributes:
1414
label: Are you willing to help implement and maintain this feature?
15-
description: |
16-
Every feature we add is code that we will have to maintain and keep updated. This takes a lot of effort.
17-
If you are willing to be involved in the project and help maintain your feature, it will make it easier for us to accept it.
15+
description: >
16+
Every feature we add is code that we will have to maintain and keep updated.
17+
This takes a lot of effort. If you are willing to be involved in the project and
18+
help maintain your feature, it will make it easier for us to accept it.
1819
options:
1920
- "No"
2021
- "Yes"

.github/ISSUE_TEMPLATE/3-module_request.yaml

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,23 +5,29 @@ labels: ["feature request"]
55
body:
66
- type: markdown
77
attributes:
8-
value: |
9-
Please replace `<module-name>` in the issue title and the description with the name of the requested module and add the description of the module.
8+
value: >
9+
Please replace `<module-name>` in the issue title and the description with the
10+
name of the requested module and add the description of the module.
1011
- type: textarea
1112
id: which-module
1213
attributes:
1314
label: Description of the desired module
14-
description: Please be as detailed as you can in your description. If possible, include an example of how you would like to use this feature (even better if it's a code example).
15-
placeholder: Implement [`<module-name>`](https://docs.generic-mapping-tools.org/latest/<module-name>.html) which `<insert description of the GMT module>`.
15+
description: >
16+
Please be as detailed as you can in your description. If possible, include
17+
an example of how you would like to use this feature (even better if it's a code example).
18+
placeholder: >
19+
Implement [`<module-name>`](https://docs.generic-mapping-tools.org/latest/<module-name>.html)
20+
which `<insert description of the GMT module>`.
1621
validations:
1722
required: true
1823
- type: dropdown
1924
id: help
2025
attributes:
2126
label: Are you willing to help implement and maintain this feature?
22-
description: |
23-
Every feature we add is code that we will have to maintain and keep updated. This takes a lot of effort.
24-
If you are willing to be involved in the project and help maintain your feature, it will make it easier for us to accept it.
27+
description: >
28+
Every feature we add is code that we will have to maintain and keep updated.
29+
This takes a lot of effort. If you are willing to be involved in the project and
30+
help maintain your feature, it will make it easier for us to accept it.
2531
options:
2632
- "No"
2733
- "Yes"
@@ -30,5 +36,6 @@ body:
3036
required: true
3137
- type: markdown
3238
attributes:
33-
value: |
34-
Progress on wrapping the module will be tracked in the [project board](https://github.com/GenericMappingTools/pygmt/projects/9).
39+
value: >
40+
Progress on wrapping the module will be tracked in the
41+
[project board](https://github.com/orgs/GenericMappingTools/projects/3).

0 commit comments

Comments
 (0)