Skip to content

Commit dbac1da

Browse files
vjovanovvjovanov
committed
Update existing library template
1 parent 9e9c7cf commit dbac1da

File tree

9 files changed

+371
-134
lines changed

9 files changed

+371
-134
lines changed

‎.github/ISSUE_TEMPLATE/01_support_new_library.yml‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
name: "📚 Support a new library"
2+
description: Submit a request to add support for a third-party library
3+
title: "Support for {maven_coordinates}"
4+
labels:
5+
- library-new-request
6+
assignees:
7+
- kimeta
8+
body:
9+
- type: markdown
10+
attributes:
11+
value: |
12+
Please fill out the following details to help us evaluate and prioritize your request.
13+
14+
- type: input
15+
id: maven_coordinates
16+
attributes:
17+
label: Full Maven coordinates
18+
description: Include the version that you need. The system might support older versions so more people can benefit.
19+
placeholder: groupId:artifactId:version
20+
validations:
21+
required: true
22+
23+
- type: input
24+
id: source_code_link
25+
attributes:
26+
label: Library source code URL
27+
description: Link to the upstream source repository (e.g., GitHub).
28+
placeholder: https://github.com/org/repo
29+
validations:
30+
required: true
31+
32+
- type: input
33+
id: test_suite_link
34+
attributes:
35+
label: Link to the existing test suite
36+
description: Provide a link to the library's test suite (enter N/A if it does not exist).
37+
placeholder: for example, https://github.com/netty/netty/tree/4.2/testsuite-common (or N/A if the suite can't be found)
38+
validations:
39+
required: true
40+
41+
- type: checkboxes
42+
id: self_support
43+
attributes:
44+
label: Contribution preference
45+
description: Check this if you want to [contribute](https://github.com/oracle/graalvm-reachability-metadata/blob/master/CONTRIBUTING.md) the reachability metadata yourself instead of using the AI generation.
46+
options:
47+
- label: "I want to provide support myself and don't want the AI generation to do it for me."
48+
49+
- type: textarea
50+
id: reason
51+
attributes:
52+
label: Reason for requesting the library
53+
description: Explain your use case and why support for this library is important.
54+
placeholder: Briefly describe your motivation and expected benefits.
55+
validations:
56+
required: false
57+
58+
- type: textarea
59+
id: logs
60+
attributes:
61+
label: Logs and error messages
62+
description: |
63+
If you're experiencing errors, paste the relevant error messages or stack traces here.
64+
For large logs, use code blocks or provide links to files.
65+
Please follow the [troubleshooting guide](https://www.graalvm.org/latest/reference-manual/native-image/guides/troubleshoot-run-time-errors/) and include any missing metadata stack traces.
66+
placeholder: |
67+
```console
68+
<log content>
69+
```
70+
render: text
71+
validations:
72+
required: false

‎.github/ISSUE_TEMPLATE/02_update_existing_library.yml‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
name: "🛠️ Update an existing library"
2+
description: Report a problem or request improvements for a library that is already supported
3+
title: "Update existing library: {maven_coordinates}"
4+
labels:
5+
- library-update-request
6+
assignees:
7+
- vjovanov
8+
body:
9+
- type: markdown
10+
attributes:
11+
value: |
12+
Use this form to report issues or request fixes for libraries that already have support in this repository.
13+
14+
- type: input
15+
id: maven_coordinates
16+
attributes:
17+
label: Full Maven coordinates
18+
description: Include a version that is failing for you.
19+
placeholder: groupId:artifactId:version
20+
validations:
21+
required: true
22+
23+
- type: textarea
24+
id: details
25+
attributes:
26+
label: Additional context and logs
27+
description: Provide any relevant error messages, stack traces, or additional details about the issue. Links to logs are also welcome. Please follow the [troubleshooting guide](https://www.graalvm.org/latest/reference-manual/native-image/guides/troubleshoot-run-time-errors/) and include any missing metadata stack traces.
28+
placeholder: Paste key logs, stack traces, or links here (optional, but highly appreciated).
29+
validations:
30+
required: false
31+
32+
- type: markdown
33+
attributes:
34+
value: |
35+
36+
### System information
37+
38+
- type: input
39+
id: graalvm_version
40+
attributes:
41+
label: GraalVM version
42+
description: State the exact GraalVM distribution and version you used (e.g., "GraalVM 25.0.1", "Oracle GraalVM 25.0.1").
43+
placeholder: e.g., GraalVM 25.0.2
44+
validations:
45+
required: true
46+
47+
- type: dropdown
48+
id: operating_system
49+
attributes:
50+
label: Operating system
51+
description: Select the operating system used to reproduce the issue.
52+
options:
53+
- Linux
54+
- macOS
55+
- Windows
56+
- Other
57+
validations:
58+
required: true
59+
60+
- type: dropdown
61+
id: architecture
62+
attributes:
63+
label: CPU architecture
64+
description: Select the CPU architecture used to reproduce the issue.
65+
options:
66+
- AMD64 (x86-64)
67+
- AARCH64 (ARM64)
68+
- RISC-V
69+
validations:
70+
required: true

‎.github/ISSUE_TEMPLATE/03_question.yml‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
name: "❓ Question"
2+
description: Ask a question about proper usage.
3+
title: "Question: "
4+
labels:
5+
- question
6+
assignees:
7+
- vjovanov
8+
9+
body:
10+
- type: markdown
11+
attributes:
12+
value: |
13+
Thanks for opening a question!
14+
15+
- type: textarea
16+
id: question_description
17+
attributes:
18+
label: Describe the question in more detail
19+
description: What do you need help with? What behavior did you observe and what did you expect?
20+
placeholder: Provide a clear and concise description of your question or problem.
21+
validations:
22+
required: true
23+
24+
- type: textarea
25+
id: reproduce_steps
26+
attributes:
27+
label: Steps or minimal example (if applicable)
28+
description: If your question involves a specific setup or behavior, please provide steps or a minimal example.
29+
placeholder: |
30+
1. ...
31+
2. ...
32+
3. ...
33+
render: markdown
34+
validations:
35+
required: false
36+
37+
- type: input
38+
id: reproducer_link
39+
attributes:
40+
label: Minimal reproducer (optional)
41+
description: Link to a public repository/branch or artifact demonstrating the case, if applicable.
42+
placeholder: https://github.com/org/repo/tree/branch
43+
validations:
44+
required: false
45+
46+
- type: textarea
47+
id: additional_context
48+
attributes:
49+
label: Additional context
50+
description: |
51+
Any other context, screenshots, or details that could help clarify your question.
52+
Please make sure to follow the [troubleshooting guide](https://www.graalvm.org/latest/reference-manual/native-image/guides/troubleshoot-run-time-errors/) and to include the missing metadata stack traces.
53+
placeholder: Environment details, related configurations, or hypotheses (optional).
54+
validations:
55+
required: false

‎.github/ISSUE_TEMPLATE/04_feature_request.yml‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
name: "💡 Feature request"
2+
description: Suggest an idea for this project
3+
title: "Feature: "
4+
labels:
5+
- enhancement
6+
assignees:
7+
- vjovanov
8+
9+
body:
10+
- type: markdown
11+
attributes:
12+
value: |
13+
Thanks for suggesting a feature!
14+
15+
- type: textarea
16+
id: problem
17+
attributes:
18+
label: Is your feature request related to a problem?
19+
description: Describe the problem you're facing. What are you trying to accomplish? Why is it important?
20+
placeholder: I'm always frustrated when [...]
21+
validations:
22+
required: true
23+
24+
- type: textarea
25+
id: solution
26+
attributes:
27+
label: Describe the solution you'd like
28+
description: Clearly describe what you want to happen. Include details about expected behavior and scope.
29+
placeholder: I would like [...]
30+
validations:
31+
required: true
32+
33+
- type: textarea
34+
id: alternatives
35+
attributes:
36+
label: Describe alternatives you've considered
37+
description: List any alternative solutions or workarounds you've tried or considered.
38+
placeholder: Alternatives or workarounds [...]
39+
validations:
40+
required: false
41+
42+
- type: textarea
43+
id: additional_context
44+
attributes:
45+
label: Additional context
46+
description: Add any other context or screenshots about the feature request here.
47+
placeholder: Screenshots, references, related issues/PRs, etc. (optional)
48+
validations:
49+
required: false

‎.github/ISSUE_TEMPLATE/05_bug_report.yml‎

Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,125 @@
1+
name: "⚠️ Bug report"
2+
description: Create a report to help us improve the reachability metadata repo.
3+
title: "Bug: "
4+
labels:
5+
- bug
6+
assignees:
7+
- vjovanov
8+
9+
body:
10+
- type: markdown
11+
attributes:
12+
value: |
13+
Thanks for taking the time to file a bug report.
14+
15+
Important:
16+
- This form is for general bugs in this repository.
17+
- If your issue is specific to a single third-party library's metadata, please use one of these forms instead:
18+
- "📚 Support a new library"
19+
- "🛠️ Update an existing library"
20+
21+
- type: textarea
22+
id: bug_description
23+
attributes:
24+
label: Describe the bug
25+
description: A clear and concise description of the bug.
26+
placeholder: What happened? What did you expect to happen instead?
27+
validations:
28+
required: true
29+
30+
- type: textarea
31+
id: reproduce_steps
32+
attributes:
33+
label: Steps to reproduce
34+
description: |
35+
Provide clear steps to reproduce the behavior. Use code blocks for configuration and commands.
36+
You can attach a minimal reproducer (zip file or link to a public repository/branch).
37+
placeholder: |
38+
1. ...
39+
2. ...
40+
3. ...
41+
render: markdown
42+
validations:
43+
required: true
44+
45+
- type: textarea
46+
id: expected_behavior
47+
attributes:
48+
label: Expected behavior
49+
description: A clear and concise description of what you expected to happen.
50+
placeholder: What did you expect to happen?
51+
validations:
52+
required: true
53+
54+
- type: textarea
55+
id: logs
56+
attributes:
57+
label: Logs and error messages
58+
description: |
59+
Include relevant error messages, stack traces, or log excerpts that show the problem. Use code blocks for large logs or provide links to files.
60+
Please follow the [troubleshooting guide](https://www.graalvm.org/latest/reference-manual/native-image/guides/troubleshoot-run-time-errors/) and include any missing metadata stack traces.
61+
placeholder: |
62+
```console
63+
<log content>
64+
```
65+
render: text
66+
validations:
67+
required: true
68+
69+
- type: input
70+
id: reproducer_link
71+
attributes:
72+
label: Reproducer (optional)
73+
description: Link to a public repository/branch or a shared artifact containing a minimal reproducer.
74+
placeholder: https://github.com/org/repo/tree/branch
75+
validations:
76+
required: false
77+
78+
- type: textarea
79+
id: additional_context
80+
attributes:
81+
label: Additional context
82+
description: Add any other context that might help investigate the problem.
83+
placeholder: Any other relevant details, environment specifics, or hypotheses.
84+
validations:
85+
required: false
86+
87+
- type: markdown
88+
attributes:
89+
value: |
90+
91+
### System information
92+
93+
- type: input
94+
id: graalvm_version
95+
attributes:
96+
label: GraalVM version
97+
description: State the exact GraalVM distribution and version you used (e.g., "GraalVM 25.0.1", "Oracle GraalVM 25.0.1").
98+
placeholder: e.g., GraalVM 25.0.2
99+
validations:
100+
required: true
101+
102+
- type: dropdown
103+
id: operating_system
104+
attributes:
105+
label: Operating system
106+
description: Select the operating system used to reproduce the issue.
107+
options:
108+
- Linux
109+
- macOS
110+
- Windows
111+
- Other
112+
validations:
113+
required: true
114+
115+
- type: dropdown
116+
id: architecture
117+
attributes:
118+
label: CPU architecture
119+
description: Select the CPU architecture used to reproduce the issue.
120+
options:
121+
- AMD64 (x86-64)
122+
- AARCH64 (ARM64)
123+
- RISC-V
124+
validations:
125+
required: true

0 commit comments

Comments
 (0)