Skip to content

Commit

Permalink
Update issue templates to clarify intended usage
Browse files Browse the repository at this point in the history
People are often not removing the boilerplate text and quoting
their text, replicating the boilerplate quoted text.
  • Loading branch information
eldering committed Sep 22, 2024
1 parent 3a896f6 commit 69acb63
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 22 deletions.
30 changes: 16 additions & 14 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,32 +7,34 @@ assignees: ''

---

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

Please remove this introduction and any unused template sections below before submitting this bug report.

### Description of the problem
> Replace this line with a short description.
Replace this line with a short description.

### Your environment
> Include details about your installation here.
> - DOMjudge version (e.g. 7.0.0 or a github commit hash)
> - Operating system / Linux distribution and version (e.g. Ubuntu 18.04)
> - Webserver (e.g. Apache or nginx)
Include details about your installation here.
- DOMjudge version (e.g. 7.0.0 or a github commit hash)
- Operating system / Linux distribution and version (e.g. Ubuntu 18.04)
- Webserver (e.g. Apache or nginx)

### Steps to reproduce
> Replace this with a description how we can reproduce your bug.
> - Step 1
> - Step 2
> - Step 3
Replace this with a description how we can reproduce your bug.
- Step 1
- Step 2
- Step 3

### Expected behaviour
> Replace this line with what you would expect to happen.
eplace this line with what you would expect to happen.

### Actual behaviour
> Replace this line with what happens instead.
Replace this line with what happens instead.

### Any other information that you want to share?
> Please include webserver, symfony and judgedaemon log snippets here as appropriate.
> Screenshots may help in case of UI bugs.
Please include webserver, symfony and judgedaemon log snippets here as appropriate.
Screenshots may help in case of UI bugs.
19 changes: 11 additions & 8 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ assignees: ''

---

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

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

Please remove this introduction and any unused template sections below before submitting this feature request.

### Description of the enhancement request
> Replace this line with a short description.
Replace this line with a short description.

### The goal you want to achieve
> 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.
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.

### Expected behaviour
> Replace this line with what you would expect to happen.
> Please describe the workflow how you want this feature to work with expected start URL
> - Step 1
> - Step 2
Replace this line with what you would expect to happen.
Please describe the workflow how you want this feature to work with expected start URL
- Step 1
- Step 2

### Any other information that you want to share?
> Screenshots may help in case of UI enhancements with annotated drawings.
Screenshots may help in case of UI enhancements with annotated drawings.

0 comments on commit 69acb63

Please sign in to comment.