Skip to content

Commit ffc2ef6

Browse files
feat: adds GitHub issue templates (#8)
1 parent 0b68d22 commit ffc2ef6

File tree

4 files changed

+88
-0
lines changed

4 files changed

+88
-0
lines changed
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: "🐞 Bug report"
2+
description: Create a report to help us improve
3+
labels: ["pending triage"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thank you for taking the time to fill out this bug report!
9+
10+
Please carefully read the contribution docs before creating a bug report
11+
👉 https://github.com/thriving-dev/java-library-template/blob/main/CONTRIBUTING.md
12+
- type: textarea
13+
id: bug-description
14+
attributes:
15+
label: Describe the bug
16+
description: A clear and concise description of what the bug is. What is the current behaviour vs. what do you expect to happen? If you intend to submit a PR for this issue, tell us in the description. Thanks!
17+
placeholder: Bug description
18+
validations:
19+
required: true
20+
- type: input
21+
id: version
22+
attributes:
23+
label: Library version(s) affected
24+
description: What library version did you experience this bug with? Which versions are affected (when known)?
25+
validations:
26+
required: true
27+
- type: textarea
28+
id: reproduce
29+
attributes:
30+
label: Steps to reproduce
31+
description: Please describe how we can reproduce the behavior.
32+
- type: textarea
33+
id: additonal
34+
attributes:
35+
label: Additional context, environment
36+
description: If applicable, add any other context about the problem here. This could also include technical context and environment information such as e.g. OS, Java version, language.
37+
- type: textarea
38+
id: logs
39+
attributes:
40+
label: Logs
41+
description: |
42+
Optional if provided reproduction. Please try not to insert an image but copy paste the log text.
43+
render: shell-script

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: 💬 Discussions
4+
url: https://github.com/thriving-dev/java-library-template/discussions
5+
about: Use discussions if you have another issue, an idea for improvement or for asking questions.
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: "🚀 Feature request"
2+
description: Suggest an idea for this project
3+
labels: ["pending triage"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thank you for taking the time to fill out this feature request!
9+
10+
Please carefully read the contribution docs before suggesting a new feature
11+
👉 https://github.com/thriving-dev/java-library-template/blob/main/CONTRIBUTING.md
12+
- type: textarea
13+
id: feature-description
14+
attributes:
15+
label: Describe the feature
16+
description: A clear and concise description of what you think would be a helpful addition, including the possible use cases and alternatives you have considered. If you have a working prototype that implements it, please include a link.
17+
placeholder: Feature description
18+
validations:
19+
required: true
20+
- type: checkboxes
21+
id: additional-info
22+
attributes:
23+
label: Additional information
24+
description: Additional information that helps us decide how to proceed.
25+
options:
26+
- label: Would you be willing to help implement this feature?
27+
- type: checkboxes
28+
id: required-info
29+
attributes:
30+
label: Final checks
31+
description: Before submitting, please make sure you do the following
32+
options:
33+
- label: Read the [contribution guide](https://github.com/thriving-dev/java-library-template/blob/main/CONTRIBUTING.md).
34+
required: true
35+
- label: Check existing [discussions](https://github.com/thriving-dev/java-library-template/discussions) and [issues](https://github.com/thriving-dev/java-library-template/issues).
36+
required: true

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,7 @@
77
[![Javadoc](https://img.shields.io/badge/JavaDoc-Online-green)](https://thriving-dev.github.io/java-library-template/javadoc/)
88

99
Java library template • Gradle • GitHub Actions CI/CD to build, release & publish to Maven Central • Renovate • Trivy Scan • Issue & PR Templates
10+
11+
### Credits
12+
- inspired by https://github.com/cortinico/kotlin-android-template
13+
- PR & issue templates copied / adapted from https://github.com/nuxt/nuxt

0 commit comments

Comments
 (0)