Skip to content

Commit 69acb63

Browse files
committed
Update issue templates to clarify intended usage
People are often not removing the boilerplate text and quoting their text, replicating the boilerplate quoted text.
1 parent 3a896f6 commit 69acb63

File tree

2 files changed

+27
-22
lines changed

2 files changed

+27
-22
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -7,32 +7,34 @@ assignees: ''
77

88
---
99

10-
NOTE: If this is a _discussion starter_, you need any _installation help_ or have a _question_ on how to accomplish something,
10+
NOTE: If this is a _discussion starter_, you need any _installation help, or have a _question_ on how to accomplish something,
1111
rather post at [our discussion channel](https://www.domjudge.org/chat) or send an email to our
1212
[DOMjudge-devel mailinglist](https://www.domjudge.org/mailman/postorius/lists/domjudge-devel.domjudge.org/)
1313
instead of filing an issue here.
1414

15+
Please remove this introduction and any unused template sections below before submitting this bug report.
16+
1517
### Description of the problem
16-
> Replace this line with a short description.
18+
Replace this line with a short description.
1719

1820
### Your environment
19-
> Include details about your installation here.
20-
> - DOMjudge version (e.g. 7.0.0 or a github commit hash)
21-
> - Operating system / Linux distribution and version (e.g. Ubuntu 18.04)
22-
> - Webserver (e.g. Apache or nginx)
21+
Include details about your installation here.
22+
- DOMjudge version (e.g. 7.0.0 or a github commit hash)
23+
- Operating system / Linux distribution and version (e.g. Ubuntu 18.04)
24+
- Webserver (e.g. Apache or nginx)
2325

2426
### Steps to reproduce
25-
> Replace this with a description how we can reproduce your bug.
26-
> - Step 1
27-
> - Step 2
28-
> - Step 3
27+
Replace this with a description how we can reproduce your bug.
28+
- Step 1
29+
- Step 2
30+
- Step 3
2931

3032
### Expected behaviour
31-
> Replace this line with what you would expect to happen.
33+
eplace this line with what you would expect to happen.
3234

3335
### Actual behaviour
34-
> Replace this line with what happens instead.
36+
Replace this line with what happens instead.
3537

3638
### Any other information that you want to share?
37-
> Please include webserver, symfony and judgedaemon log snippets here as appropriate.
38-
> Screenshots may help in case of UI bugs.
39+
Please include webserver, symfony and judgedaemon log snippets here as appropriate.
40+
Screenshots may help in case of UI bugs.

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ assignees: ''
77

88
---
99

10-
NOTE: If this is a _discussion starter_, you need any _installation help_ or have a _question_ on how to accomplish something,
10+
NOTE: If this is a _discussion starter_, you need any _installation help, or have a _question_ on how to accomplish something,
1111
rather post at [our discussion channel](https://www.domjudge.org/chat) or send an email to our
1212
[DOMjudge-devel mailinglist](https://www.domjudge.org/mailman/postorius/lists/domjudge-devel.domjudge.org/).
1313

@@ -16,16 +16,19 @@ request, it might be useful to discuss it first via the chat or mailing list
1616
linked above. We can then assess together whether there is
1717
not already a way to accomplish your goal with DOMjudge currently.
1818

19+
Please remove this introduction and any unused template sections below before submitting this feature request.
20+
1921
### Description of the enhancement request
20-
> Replace this line with a short description.
22+
Replace this line with a short description.
2123

2224
### The goal you want to achieve
23-
> Please elaborate on the (larger, higher level) goal you want to achieve with this enhancement, so we have a good understanding what this feature would be useful for and how it fits in DOMjudge as a whole.
25+
Please elaborate on the (larger, higher level) goal you want to achieve with this enhancement, so we have a good understanding what this feature would be useful for and how it fits in DOMjudge as a whole.
2426

2527
### Expected behaviour
26-
> Replace this line with what you would expect to happen.
27-
> Please describe the workflow how you want this feature to work with expected start URL
28-
> - Step 1
29-
> - Step 2
28+
Replace this line with what you would expect to happen.
29+
Please describe the workflow how you want this feature to work with expected start URL
30+
- Step 1
31+
- Step 2
32+
3033
### Any other information that you want to share?
31-
> Screenshots may help in case of UI enhancements with annotated drawings.
34+
Screenshots may help in case of UI enhancements with annotated drawings.

0 commit comments

Comments
 (0)