Skip to content

Commit 6db2a05

Browse files
SplatcrafterSplatcrafter
committed
Add GitHub issue and discussion templates for standardizing project communication.
1 parent 485e5b2 commit 6db2a05

12 files changed

Lines changed: 650 additions & 0 deletions

File tree

‎.github/CODEOWNERS‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
* @aether-framework/maintainers
2+
3+
/.github/workflows/ @aether-framework/maintainers

‎.github/DISCUSSION_TEMPLATE/ideas.yml‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
title: "Idea / RFC"
2+
labels: ["enhancement", "discussion"]
3+
body:
4+
- type: markdown
5+
attributes:
6+
value: |
7+
Use this to propose new features or API changes before opening a PR.
8+
The more concrete the use-case, the better.
9+
10+
- type: textarea
11+
id: motivation
12+
attributes:
13+
label: Motivation / Problem
14+
placeholder: What problem does this solve?
15+
validations:
16+
required: true
17+
18+
- type: textarea
19+
id: proposal
20+
attributes:
21+
label: Proposal
22+
placeholder: Describe the proposed behavior and how users would use it.
23+
validations:
24+
required: true
25+
26+
- type: textarea
27+
id: api
28+
attributes:
29+
label: API / Design Sketch (optional)
30+
description: If you have a rough idea of the public API, put it here.
31+
render: java
32+
validations:
33+
required: false
34+
35+
- type: textarea
36+
id: breaking
37+
attributes:
38+
label: Breaking Changes / Migration
39+
description: Would this be breaking? If yes, what would migration look like?
40+
validations:
41+
required: false
42+
43+
- type: dropdown
44+
id: priority
45+
attributes:
46+
label: Priority (estimate)
47+
options:
48+
- low
49+
- medium
50+
- high
51+
validations:
52+
required: true

‎.github/DISCUSSION_TEMPLATE/q-a.yml‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
title: "Q&A / Help"
2+
labels: ["question"]
3+
body:
4+
- type: markdown
5+
attributes:
6+
value: |
7+
Use this for usage questions and help requests.
8+
For reproducible bugs, please open an Issue instead.
9+
10+
- type: input
11+
id: version
12+
attributes:
13+
label: Version
14+
description: Which version are you using?
15+
placeholder: e.g. 0.5.0 (or main @ <commit>)
16+
validations:
17+
required: false
18+
19+
- type: dropdown
20+
id: module
21+
attributes:
22+
label: Module
23+
options:
24+
- api
25+
- core
26+
- codec
27+
- testkit
28+
- cli
29+
- schema-tools
30+
- spring-boot-starter
31+
- other / unknown
32+
validations:
33+
required: false
34+
35+
- type: textarea
36+
id: goal
37+
attributes:
38+
label: Goal
39+
description: What are you trying to accomplish?
40+
placeholder: Be specific about the desired outcome.
41+
validations:
42+
required: true
43+
44+
- type: textarea
45+
id: what_tried
46+
attributes:
47+
label: What did you try?
48+
description: Include minimal code/config and what happened.
49+
render: java
50+
validations:
51+
required: false
52+
53+
- type: textarea
54+
id: context
55+
attributes:
56+
label: Context
57+
description: Anything else that helps (stacktraces, links, constraints).
58+
validations:
59+
required: false

‎.github/DISCUSSION_TEMPLATE/show-and-tell.yml‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
title: "Show & Tell"
2+
labels: ["community"]
3+
body:
4+
- type: markdown
5+
attributes:
6+
value: |
7+
Show what you built with this project!
8+
Share links, screenshots, benchmarks, or lessons learned.
9+
10+
- type: input
11+
id: project
12+
attributes:
13+
label: Project name
14+
placeholder: e.g. MyGameSaveMigrator
15+
validations:
16+
required: true
17+
18+
- type: input
19+
id: link
20+
attributes:
21+
label: Link (optional)
22+
placeholder: Repository / website / blog post
23+
validations:
24+
required: false
25+
26+
- type: textarea
27+
id: summary
28+
attributes:
29+
label: What did you build?
30+
placeholder: Describe the project and how this library is used.
31+
validations:
32+
required: true
33+
34+
- type: textarea
35+
id: learnings
36+
attributes:
37+
label: Learnings / Feedback
38+
description: What worked well? What should be improved?
39+
validations:
40+
required: false

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 131 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,131 @@
1+
name: 🐞 Bug Report
2+
description: Report a reproducible bug or unexpected behavior
3+
title: "[Bug]: "
4+
labels: ["bug", "needs-triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for the report! Please provide enough details so we can reproduce and fix the issue quickly.
10+
11+
- type: input
12+
id: affected_version
13+
attributes:
14+
label: Affected Version
15+
description: Which version(s) are affected?
16+
placeholder: e.g. 0.5.0 (or main @ <commit>)
17+
validations:
18+
required: true
19+
20+
- type: dropdown
21+
id: affected_module
22+
attributes:
23+
label: Affected Module
24+
description: Which module is affected?
25+
options:
26+
- api
27+
- core
28+
- codec
29+
- testkit
30+
- cli
31+
- schema-tools
32+
- spring-boot-starter
33+
- other / unknown
34+
validations:
35+
required: true
36+
37+
- type: textarea
38+
id: summary
39+
attributes:
40+
label: Summary
41+
description: Short summary of what is wrong.
42+
placeholder: One or two sentences.
43+
validations:
44+
required: true
45+
46+
- type: textarea
47+
id: expected
48+
attributes:
49+
label: Expected Behavior
50+
description: What did you expect to happen?
51+
validations:
52+
required: true
53+
54+
- type: textarea
55+
id: actual
56+
attributes:
57+
label: Actual Behavior
58+
description: What happened instead?
59+
validations:
60+
required: true
61+
62+
- type: textarea
63+
id: repro_steps
64+
attributes:
65+
label: Steps to Reproduce
66+
description: Provide a minimal, complete, reproducible set of steps.
67+
placeholder: |
68+
1. ...
69+
2. ...
70+
3. ...
71+
validations:
72+
required: true
73+
74+
- type: textarea
75+
id: minimal_example
76+
attributes:
77+
label: Minimal Reproducible Example (code/config)
78+
description: If possible, paste a small snippet that reproduces the issue.
79+
render: java
80+
validations:
81+
required: false
82+
83+
- type: textarea
84+
id: stacktrace
85+
attributes:
86+
label: Logs / Stacktrace
87+
description: Paste relevant logs or the full stacktrace.
88+
render: shell
89+
validations:
90+
required: false
91+
92+
- type: dropdown
93+
id: regression
94+
attributes:
95+
label: Regression?
96+
description: Did this work in a previous version?
97+
options:
98+
- "unknown"
99+
- "yes"
100+
- "no"
101+
validations:
102+
required: true
103+
104+
- type: input
105+
id: last_working_version
106+
attributes:
107+
label: Last Known Working Version (if regression)
108+
placeholder: e.g. 0.4.0
109+
validations:
110+
required: false
111+
112+
- type: input
113+
id: environment
114+
attributes:
115+
label: Environment
116+
description: Java version, OS, build tool, etc.
117+
placeholder: e.g. Java 21, Maven 3.9.x, Windows 11 / Ubuntu 24.04
118+
validations:
119+
required: false
120+
121+
- type: checkboxes
122+
id: checklist
123+
attributes:
124+
label: Checklist
125+
options:
126+
- label: I searched existing issues to avoid duplicates.
127+
required: true
128+
- label: I can reproduce this reliably.
129+
required: false
130+
- label: I included a minimal example or clear repro steps.
131+
required: false

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: 🔒 Security Policy
4+
url: https://github.com/aether-framework/aether-datafixers/security/policy
5+
about: Please report serious vulnerabilities via the security policy / advisories.
6+
- name: 📖 Documentation
7+
url: https://github.com/aether-framework/aether-datafixers
8+
about: Check the README and docs first.

‎.github/ISSUE_TEMPLATE/documentation.yml‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
name: 📚 Documentation
2+
description: Report missing, unclear, or incorrect documentation
3+
title: "[Docs]: "
4+
labels: ["documentation"]
5+
body:
6+
- type: input
7+
id: location
8+
attributes:
9+
label: Location
10+
description: Where is the docs issue? (URL, file path, section)
11+
placeholder: e.g. docs/codec.md#json or README.md#usage
12+
validations:
13+
required: true
14+
15+
- type: dropdown
16+
id: type
17+
attributes:
18+
label: Type
19+
options:
20+
- typo / wording
21+
- unclear explanation
22+
- missing section
23+
- incorrect/outdated information
24+
- broken link
25+
- example does not work
26+
validations:
27+
required: true
28+
29+
- type: textarea
30+
id: current
31+
attributes:
32+
label: Current Content / Problem
33+
description: What exactly is wrong right now?
34+
placeholder: Paste the relevant snippet or describe the issue precisely.
35+
validations:
36+
required: true
37+
38+
- type: textarea
39+
id: expected
40+
attributes:
41+
label: Suggested Change
42+
description: What should it say/do instead?
43+
placeholder: Proposed wording, fixed link, corrected example, etc.
44+
validations:
45+
required: false
46+
47+
- type: textarea
48+
id: context
49+
attributes:
50+
label: Context (optional)
51+
description: Why is it confusing? Who is the target audience?
52+
validations:
53+
required: false

0 commit comments

Comments
 (0)