Skip to content
This repository was archived by the owner on May 10, 2024. It is now read-only.

Commit 94a34f0

Browse files
committed
update issue templates
1 parent f6ad72f commit 94a34f0

File tree

7 files changed

+52
-88
lines changed

7 files changed

+52
-88
lines changed

.github/ISSUE_TEMPLATE/bug.yml

Lines changed: 15 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -3,68 +3,49 @@ description: Report a bug
33
labels: [bug]
44
assignees: []
55
body:
6-
- type: checkboxes
7-
id: checks
6+
- type: markdown
87
attributes:
9-
label: Prerequisites
10-
description: |
11-
*If **all** checks are not passed then the issue will be closed.*
12-
options:
13-
- label: I have checked that no other similar issue already exists.
14-
required: true
15-
- label: I have checked that this issue is actually a bug and not a feature.
16-
required: true
17-
- label: I have checked the [documentation](https://docs.katsute.dev/simplehttpserver).
18-
required: true
8+
value: |
9+
Before opening a bug report please check that your issue was not already discussed in the following:
10+
11+
* [Issues](https://github.com/KatsuteDev/simplehttpserver/issues?q=is%3Aissue+is%3Aopen+label%3Abug%2C%22critical+bug%22)
12+
* [Documentation](https://docs.katsute.dev/simplehttpserver)
13+
14+
Please also check that:
15+
16+
* This is actually a bug and not a feature.
17+
* You are running the latest version.
1918
2019
- type: input
21-
id: os
2220
attributes:
2321
label: Operating System
24-
description: |
25-
Operating system name and version.
26-
placeholder: |
27-
ex: Windows 10
2822
validations:
2923
required: true
3024

3125
- type: input
32-
id: java-version
3326
attributes:
3427
label: Java Version
35-
description: |
36-
Java version.
37-
placeholder: |
38-
ex: Java 11
3928
validations:
4029
required: true
4130

4231
- type: input
43-
id: version
4432
attributes:
4533
label: Release Version
4634
description: |
47-
Release version or branch commit where the issue occurred. Do not write 'latest'.
48-
placeholder: |
49-
ex: 1.0.0, 335794d
35+
Do not write 'latest'.
5036
validations:
5137
required: true
5238

5339
- type: textarea
54-
id: issue
5540
attributes:
5641
label: Issue
57-
description: |
58-
Explain your issue, add any relevant stacktraces here.
5942
validations:
6043
required: true
6144

6245
- type: textarea
63-
id: code
6446
attributes:
65-
label: Code
47+
label: How to replicate
6648
description: |
67-
(optional) Add any relevant code so we can try and replicate the issue.
68-
render: Java
49+
Include steps to reproduce this issue.
6950
validations:
70-
required: false
51+
required: true

.github/ISSUE_TEMPLATE/documentation.yml

Lines changed: 11 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -3,34 +3,28 @@ description: Report a documentation issue
33
labels: [bug, documentation]
44
assignees: []
55
body:
6-
- type: checkboxes
7-
id: checks
6+
- type: markdown
87
attributes:
9-
label: Prerequisites
10-
description: |
11-
*If **all** checks are not passed then the issue will be closed.*
12-
options:
13-
- label: I have checked that no other similar issue already exists.
14-
required: true
15-
- label: I have checked that this issue is actually a bug and not a feature.
16-
required: true
8+
value: |
9+
Before opening a documentation report please check that your issue was not already discussed in the following:
10+
11+
* [Issues](https://github.com/KatsuteDev/simplehttpserver/issues?q=is%3Aissue+is%3Aopen+label%3Abug%2C%22critical+bug%22+label%3Adocumentation)
12+
13+
Please also check that:
14+
15+
* This is actually an issue and not intended behavior.
16+
* The issue is from the latest documentation.
1717
1818
- type: input
19-
id: location
2019
attributes:
2120
label: Location
2221
description: |
23-
Provide a link to the version or the name of the class that has the documentation issue.
24-
placeholder: |
25-
ex: SimpleHttpServer
22+
Link to the documentation issue or name of the class.
2623
validations:
2724
required: true
2825

2926
- type: textarea
30-
id: issue
3127
attributes:
3228
label: Issue
33-
description: |
34-
Explain your issue.
3529
validations:
3630
required: true

.github/ISSUE_TEMPLATE/feature.yml

Lines changed: 11 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -3,33 +3,26 @@ description: Suggest a new feature
33
labels: [feature request]
44
assignees: []
55
body:
6-
- type: checkboxes
7-
id: checks
6+
- type: markdown
87
attributes:
9-
label: Prerequisites
10-
description: |
11-
*If **all** checks are not passed then the issue will be closed.*
12-
options:
13-
- label: I have checked that no other similar feature request already exists.
14-
required: true
15-
- label: This feature request makes sense for the project.
16-
required: true
17-
- label: I have checked that this feature does not already exist.
18-
required: true
19-
- label: I am running the latest release version.
20-
required: true
8+
value: |
9+
Before opening a feature request please check that your idea was not already discussed in the following:
10+
11+
* [Issues](https://github.com/KatsuteDev/simplehttpserver/issues?q=is%3Aissue+is%3Aopen+label%3A%22feature+request%22)
12+
13+
Please also check that:
14+
15+
* This feature makes sense for the project.
16+
* This feature does not already exist.
17+
* You are running the latest version.
2118
2219
- type: textarea
23-
id: feature
2420
attributes:
2521
label: Feature
26-
description: |
27-
Explain your feature. Add any examples here.
2822
validations:
2923
required: true
3024

3125
- type: textarea
32-
id: reason
3326
attributes:
3427
label: Reason
3528
description: |

.github/pull_request_template.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11
### Prerequisites
2-
*If checks are not passed then the pull request will be closed.*
2+
*Issues must meet the following criteria:*
33

4-
- [ ] I have checked that no other similar pull request already exists.
5-
- [ ] My code follows the general code style as the rest of the code.
6-
- [ ] I have checked that no sensitive information is exposed.
7-
- [ ] I have added relevant comments.
8-
- [ ] Build compiles.
9-
- [ ] Build passes test cases.
4+
- [ ] No similar [pull request](https://github.com/KatsuteDev/simplehttpserver/pulls) exists.
5+
- [ ] Code follows the general code style of this project.
6+
- [ ] No sensitive information is exposed.
7+
- [ ] Relevant comments have been added.
108

119
### GitHub Copilot Disclaimer
1210
*The use of GitHub Copilot is **strictly prohibited** on this repository.*

.github/workflows/dependabot.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@ on: [pull_request_target]
44
jobs:
55
dependabot:
66
name: Dependabot[bot]
7-
uses: Katsute/Workflows/.github/workflows/dependabot.yml@main
7+
uses: Katsute/Workflows/.github/workflows/dependabot.yml@main

.github/workflows/java_ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,4 @@ jobs:
1212
package: true
1313
report: true
1414
secrets:
15-
token: ${{ secrets.SINON }}
15+
token: ${{ secrets.BOT }}

README.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,14 @@
99
1010
<a href="https://github.com/KatsuteDev/simplehttpserver/blob/main/setup.md#readme">Setup</a>
1111
</div>
12-
</div>
13-
14-
<br>
15-
16-
<div align="center">
17-
<a href="https://mvnrepository.com/artifact/dev.katsute/simplehttpserver">Maven Central</a>
18-
19-
GitHub Packages
20-
21-
<a href="https://github.com/KatsuteDev/simplehttpserver/releases">Releases</a>
12+
<br>
13+
<div>
14+
<a href="https://mvnrepository.com/artifact/dev.katsute/simplehttpserver">Maven Central</a>
15+
16+
GitHub Packages
17+
18+
<a href="https://github.com/KatsuteDev/simplehttpserver/releases">Releases</a>
19+
</div>
2220
</div>
2321

2422
<br>

0 commit comments

Comments
 (0)