Skip to content

Commit 1396853

Browse files
committed
docs: Refactor .github/ISSUE_TEMPLATE/*
* Use <!--HTML comments--> more often & Tweak details
1 parent 1f73141 commit 1396853

File tree

3 files changed

+57
-34
lines changed

3 files changed

+57
-34
lines changed
Lines changed: 24 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,49 @@
11
---
22
name: Bug report
3-
about: Create a report to help us improve
3+
about: Report a bug with this project
44
title: 'Bug:'
55
labels: bug
66
assignees: ''
77

88
---
99

10-
> Related issue(s) or PR(s):
11-
> Related project scope(s) (ex: client, CSS, grading, etc...) :
12-
> Related user(s):
10+
<!-- Some optional but useful fields -->
11+
12+
**Related issue(s) or PR(s):**
13+
- #…
14+
15+
**Related project scope(s):**
16+
(e.g. UI, grading, learn-ocaml-client, Teacher-dashboard, partition-view, …)
17+
18+
**Related user(s):**
19+
- @…
1320

1421
## Bug description
1522

16-
A clear and concise description of what the bug is.
23+
<!-- A clear and concise description of what the bug is -->
1724

18-
### To Reproduce
25+
### To reproduce
1926

2027
Steps to reproduce the behavior:
2128

22-
1. Go to '...'
23-
2. Click on '....'
24-
3. Scroll down to '....'
25-
4. See error
29+
1. Open …
30+
1. Click on …
31+
1. Then …
2632

2733
### Expected behavior
2834

29-
A clear and concise description of what you expected to happen.
35+
<!-- A clear and concise description of what you expected to happen -->
36+
37+
### Optional screenshots
3038

31-
### Screenshots
39+
<!-- If applicable, add screenshots to document your problem -->
3240

33-
If applicable, add screenshots to document your problem.
3441
## Current configuration
3542

36-
- OS: [e.g. iOS]
37-
- Browser [e.g. chrome, safari]
38-
- Version [e.g. 22]
43+
* OS name (and version):
44+
* Browser name (and version):
45+
* `learn-ocaml --version`:
3946

4047
## Additional context
4148

42-
Add any other context about the problem here.
49+
<!-- Add any other useful details about the problem here -->
Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,37 @@
11
---
22
name: Feature request
33
about: Suggest an idea for this project
4-
title: 'Feat:'
4+
title: 'Feature:'
55
labels: feature
66
assignees: ''
77

88
---
99

10-
> Related issue(s) or PR(s):
11-
> Related project scope(s) (ex: client, CSS, grading, etc...) :
12-
> Related user(s):
10+
<!-- Some optional but useful fields -->
11+
12+
**Related issue(s) or PR(s):**
13+
- #…
14+
15+
**Related project scope(s):**
16+
(e.g. UI, grading, learn-ocaml-client, Teacher-dashboard, partition-view, …)
17+
18+
**Related user(s):**
19+
- @…
1320

1421
## The problem
1522

16-
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
23+
<!-- A clear and concise description of what the problem is -->
24+
25+
<!-- e.g. I'm always frustrated when … -->
1726

1827
### Wanted solution
1928

20-
A clear and concise description of what you want to happen.
29+
<!-- A clear and concise description of what you want to happen -->
2130

2231
### Considered alternatives
2332

24-
A clear and concise description of any alternative solutions or features you've considered.
33+
<!-- A clear and concise description of any alternative solutions or features you considered -->
2534

2635
## Additional context
2736

28-
Add any other context or screenshots about the feature request here.
37+
<!-- Add any other useful details or screenshots about the feature request here -->

.github/ISSUE_TEMPLATE/question.md

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,24 +7,31 @@ assignees: ''
77

88
---
99

10-
> Related issue(s) or PR(s):
11-
> Related project scope(s) (ex: client, CSS, grading, etc...) :
12-
> Related user(s):
10+
<!-- Some optional but useful fields -->
11+
12+
**Related issue(s) or PR(s):**
13+
- #…
14+
15+
**Related project scope(s):**
16+
(e.g. UI, grading, learn-ocaml-client, Teacher-dashboard, partition-view, …)
17+
18+
**Related user(s):**
19+
- @…
1320

1421
## The question
1522

16-
A clear and concise description of what you want to know.
23+
<!-- A clear and concise description of what you want to know -->
1724

1825
### What has already been tested
1926

20-
A clear and concise description of what you have already tried.
27+
<!-- A clear and concise description of what you have already tried -->
2128

2229
## Current configuration
2330

24-
- OS: [e.g. iOS]
25-
- Browser [e.g. chrome, safari]
26-
- Version [e.g. 22]
31+
* OS name (and version):
32+
* Browser name (and version):
33+
* `learn-ocaml --version`:
2734

2835
## Additional context
2936

30-
Add any other context or screenshots about the inquiry.
37+
<!-- Add any other useful details or screenshots about the inquiry here -->

0 commit comments

Comments
 (0)