Skip to content

Commit 5ccc7b2

Browse files
virgile-devvirgile-dev
committed
📝(issue templates) switch to forms
so it is easier to file issues Signed-off-by: virgile-deville <virgile.deville@beta.gouv.fr>
1 parent e59d8a4 commit 5ccc7b2

6 files changed

Lines changed: 170 additions & 73 deletions

File tree

‎.github/ISSUE_TEMPLATE/Bug_report.md‎

Lines changed: 0 additions & 32 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/Feature_request.md‎

Lines changed: 0 additions & 23 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/Support_question.md‎

Lines changed: 0 additions & 18 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
name: Bug Report
2+
description: File a bug report.
3+
title: "🐛(Bug) "
4+
labels: ["triage"]
5+
projects: ["suitenumerique/2"]
6+
assignees:
7+
- virgile-dev
8+
type: bug
9+
body:
10+
- type: markdown
11+
attributes:
12+
value: |
13+
Thanks for taking the time to fill out this bug report!
14+
- type: markdown
15+
attributes:
16+
value: |
17+
Before filing a new issue, please do a quick search in the issues / prs list to avoid duplicates.
18+
- type: markdown
19+
attributes:
20+
value: |
21+
We use [BlockNote](https://www.blocknotejs.org/) for the text editing features of Docs. If you find an issue with the editor and are able to reproduce it on their [demo](https://www.blocknotejs.org/demo) it's best to report it directly on the [BlockNote repository](https://github.com/TypeCellOS/BlockNote/issues).
22+
- type: textarea
23+
id: what-happened
24+
attributes:
25+
label: What happened?
26+
description: Also tell us, what did you expect to happen?
27+
placeholder: Tell us what you see!
28+
value: "A bug happened!"
29+
validations:
30+
required: true
31+
- type: textarea
32+
id: solution
33+
attributes:
34+
label: Possible solution?
35+
description: If you have suggestions on a fix for the bug
36+
placeholder: Try this, or that ...
37+
value: "I have a solution!"
38+
validations:
39+
required: false
40+
- type: textarea
41+
id: version
42+
attributes:
43+
label: Version
44+
description: What version of our software are you running?
45+
value: "4.x.x"
46+
validations:
47+
required: false
48+
- type: input
49+
id: instance
50+
attributes:
51+
label: Instance url
52+
description: What's your instance url?
53+
value: "docs.example.org"
54+
validations:
55+
required: false
56+
- type: dropdown
57+
id: browsers
58+
attributes:
59+
label: What browsers are you seeing the problem on?
60+
multiple: true
61+
options:
62+
- Firefox
63+
- Chrome
64+
- Safari
65+
- Microsoft Edge
66+
- type: textarea
67+
id: logs
68+
attributes:
69+
label: Relevant log output
70+
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
71+
render: shell
72+
- type: upload
73+
id: screenshots
74+
attributes:
75+
label: Upload screenshots
76+
description: If applicable, add screenshots to help explain your problem.
77+
validations:
78+
required: false
79+
- type: input
80+
id: contact
81+
attributes:
82+
label: Contact Details
83+
description: How can we get in touch with you if we need more info?
84+
placeholder: ex. email@example.com
85+
validations:
86+
required: false
87+
- type: checkboxes
88+
id: terms
89+
attributes:
90+
label: Code of Conduct
91+
description: By submitting this issue, you agree to follow our [Code of Conduct](CODE_OF_CONDUCT.md).
92+
options:
93+
- label: I agree to follow this project's Code of Conduct
94+
required: true

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
blank_issues_enabled: false
2+
3+
contact_links:
4+
- name: Support question
5+
url: https://matrix.to/#/#docs-official:matrix.org
6+
about: If you have a question, or something was not clear from the docs, reach out for help on our Matrix Channel or email us at docs.team@la-suite.eu

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
name: Feature request
2+
description: Suggest an new feature or an enhancement.
3+
title: "✨(feature) "
4+
labels: ["triage"]
5+
projects: ["suitenumerique/2"]
6+
assignees:
7+
- virgile-dev
8+
type: feature
9+
body:
10+
- type: markdown
11+
attributes:
12+
value: |
13+
Thanks for taking the time to suggest a feature!
14+
- type: markdown
15+
attributes:
16+
value: |
17+
Before filing a new issue, please do a quick search in the issues / prs list to avoid duplicates.
18+
- type: markdown
19+
attributes:
20+
value: |
21+
We use [BlockNote](https://www.blocknotejs.org/) for the text editing features of Docs. It's best to suggest features on the text editor directly on the [BlockNote repository](https://github.com/TypeCellOS/BlockNote/discussions/categories/ideas-enhancements).
22+
- type: textarea
23+
id: problem
24+
attributes:
25+
label: What problem do you want to fix?
26+
description: A concise description of what the problem is.
27+
placeholder:
28+
value: "My problem is"
29+
validations:
30+
required: true
31+
- type: textarea
32+
id: solution
33+
attributes:
34+
label: Possible solution?
35+
description: A concise description of what you need to fix your problem.
36+
placeholder: I
37+
value: "I need this feature"
38+
validations:
39+
required: true
40+
- type: textarea
41+
id: alternative
42+
attributes:
43+
label: Do you have an alternative?
44+
description: If you found a workaround or have thought of another way to solve your problem.
45+
value: "My workaround is ..."
46+
validations:
47+
required: false
48+
- type: upload
49+
id: screenshots
50+
attributes:
51+
label: Upload
52+
description: If applicable, add screenshots to help explain your problem.
53+
validations:
54+
required: false
55+
- type: input
56+
id: contact
57+
attributes:
58+
label: Contact Details
59+
description: How can we get in touch with you if we need more info?
60+
placeholder: ex. email@example.com
61+
validations:
62+
required: false
63+
- type: checkboxes
64+
id: terms
65+
attributes:
66+
label: Code of Conduct
67+
description: By submitting this issue, you agree to follow our [Code of Conduct](CODE_OF_CONDUCT.md).
68+
options:
69+
- label: I agree to follow this project's Code of Conduct
70+
required: true

0 commit comments

Comments
 (0)