Skip to content

Commit f2e5c62

Browse files
Add bug report and documentation improvement issue templates (#762)
1 parent db519af commit f2e5c62

File tree

3 files changed

+41
-0
lines changed

3 files changed

+41
-0
lines changed
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
name: Bug report
2+
description: Report a broken link, rendering issue, or incorrect content
3+
title: "[Bug]: "
4+
labels: ["bug"]
5+
body:
6+
- type: input
7+
id: url
8+
attributes:
9+
label: Page URL
10+
placeholder: https://precice.org/some-page.html
11+
validations:
12+
required: true
13+
- type: textarea
14+
id: description
15+
attributes:
16+
label: What is wrong?
17+
placeholder: "The link to X returns a 404. It should point to Y."
18+
validations:
19+
required: true

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: preCICE Discourse Forum
4+
url: https://precice.discourse.group
5+
about: For usage questions, please ask on the preCICE Discourse forum instead of opening a GitHub issue.
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: Documentation improvement
2+
description: Suggest an improvement or flag missing/unclear content
3+
title: "[Docs]: "
4+
labels: ["content"]
5+
body:
6+
- type: input
7+
id: url
8+
attributes:
9+
label: Page URL (if applicable)
10+
placeholder: https://precice.org/some-page.html
11+
- type: textarea
12+
id: description
13+
attributes:
14+
label: What should be improved?
15+
placeholder: "The section on X doesn't explain Y..."
16+
validations:
17+
required: true

0 commit comments

Comments
 (0)