Skip to content

Update issue templates to clarify intended usage #2713

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 25, 2024
Merged

Update issue templates to clarify intended usage #2713

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f308efd
Update issue templates to clarify/improve intended usage
eldering Sep 22, 2024
8f42400
Update wording of feature request template a bit
eldering Sep 22, 2024
3be3d39
Use "write here" instead of "replace this" for commented text
eldering Sep 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 28 additions & 14 deletions .github/ISSUE_TEMPLATE/bug_report.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,32 +7,46 @@ 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.
-->

### Description of the problem
> Replace this line with a short description.
<!--
Write here 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
<!--
Write here a description how we can reproduce your bug.
1. Step 1
1. Step 2
1. Step 3
-->

### Expected behaviour
> Replace this line with what you would expect to happen.
<!--
Write here what you would expect to happen.
-->

### Actual behaviour
> Replace this line with what happens instead.
<!--
Write here 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.
-->
27 changes: 19 additions & 8 deletions .github/ISSUE_TEMPLATE/feature_request.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,25 +7,36 @@ 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/).

Thank you for suggesting ways to improve DOMjudge. Before you file a feature
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.
-->

### Description of the enhancement request
> Replace this line with a short description.
<!--
Write here 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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This sentence has been poorly formulated.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've updated the wording.

> - Step 1
> - Step 2
<!--
Write here what you would expect to happen.
For example describe the flow how you want this feature to work.
1. Step 1
2. Step 2
-->

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