Skip to content

Commit c093942

Browse files
committed
chore: modify issue templates
1 parent 3c48030 commit c093942

7 files changed

Lines changed: 255 additions & 55 deletions

File tree

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 0 additions & 30 deletions
This file was deleted.
Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
# Copyright 2025 Google LLC
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# https://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
15+
name: 🐞 Bug Report
16+
description: File a report for unexpected or undesired behavior.
17+
title: "<brief summary of what bug or error was observed>"
18+
labels: ["type: bug"]
19+
20+
body:
21+
- type: markdown
22+
attributes:
23+
value: |
24+
Thanks for helping us improve! 🙏 Please answer these questions and provide as much information as possible about your problem.
25+
26+
- id: preamble
27+
type: checkboxes
28+
attributes:
29+
label: Prerequisites
30+
description: |
31+
Please run through the following list and make sure you've tried the usual "quick fixes":
32+
- Search the [current open issues](https://github.com/googleapis/mcp-toolbox-sdk-java/issues)
33+
- Update to the [latest version of Toolbox](https://github.com/googleapis/genai-toolbox/releases)
34+
- Update to the [latest version of the SDK](https://github.com/googleapis/mcp-toolbox-sdk-java/blob/main/CHANGELOG.md).
35+
options:
36+
- label: "I've searched the current open issues"
37+
required: true
38+
- label: "I've updated to the latest version of Toolbox"
39+
- label: "I've updated to the latest version of the SDK"
40+
41+
- type: input
42+
id: version
43+
attributes:
44+
label: Toolbox version
45+
description: |
46+
What version of Toolbox are you using (`toolbox --version`)? e.g.
47+
- toolbox version 0.3.0
48+
- us-central1-docker.pkg.dev/database-toolbox/toolbox/toolbox:0.3.0
49+
placeholder: ex. toolbox version 0.3.0
50+
validations:
51+
required: true
52+
53+
- type: textarea
54+
id: environment
55+
attributes:
56+
label: Environment
57+
description: "Let us know some details about the environment in which you are seeing the bug!"
58+
value: |
59+
1. OS type and version: (output of `uname -a`)
60+
2. How are you running Toolbox:
61+
- As a downloaded binary (e.g. from `curl -O https://storage.googleapis.com/genai-toolbox/v$VERSION/linux/amd64/toolbox`)
62+
- As a container (e.g. from `us-central1-docker.pkg.dev/database-toolbox/toolbox/toolbox:$VERSION`)
63+
- Compiled from source (include the command used to build)
64+
3. Java version:
65+
66+
- type: textarea
67+
id: client
68+
attributes:
69+
label: Client
70+
description: "How are you connecting to Toolbox?"
71+
value: |
72+
1. Client: <name and link to the SDK are you using>
73+
2. Version: <what exact version of the SDK are you using>
74+
3. Example: If possible, please include your code of configuration:
75+
76+
```go
77+
# Code goes here!
78+
```
79+
80+
- id: expected-behavior
81+
type: textarea
82+
attributes:
83+
label: Expected Behavior
84+
description: |
85+
Please enter a detailed description of the behavior you expected, and any information about what behavior you
86+
noticed and why it is defective or unintentional.
87+
validations:
88+
required: true
89+
90+
- id: current-behavior
91+
type: textarea
92+
attributes:
93+
label: Current Behavior
94+
description: "Please enter a detailed description of the behavior you encountered instead."
95+
validations:
96+
required: true
97+
98+
- type: textarea
99+
id: repro
100+
attributes:
101+
label: Steps to reproduce?
102+
description: |
103+
How can we reproduce this bug? Please walk us through it step by step,
104+
with as much relevant detail as possible. A 'minimal' reproduction is
105+
preferred, which means removing as much of the examples as possible so
106+
only the minimum required to run and reproduce the bug is left.
107+
value: |
108+
1. ?
109+
2. ?
110+
3. ?
111+
...
112+
validations:
113+
required: true
114+
115+
- type: textarea
116+
id: additional-details
117+
attributes:
118+
label: Additional Details
119+
description: |
120+
Any other information you want us to know? Things such as tools config,
121+
server logs, etc. can be included here.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Copyright 2025 Google LLC
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# https://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
15+
blank_issues_enabled: false
16+
contact_links:
17+
- name: Google Cloud Support
18+
url: https://cloud.google.com/support/
19+
about: If you have a support contract with Google, please both open an issue here and open Google Cloud Support portal with a link to the issue.

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 0 additions & 18 deletions
This file was deleted.
Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# Copyright 2025 Google LLC
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# https://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
15+
name: ✨ Feature Request
16+
description: Suggest an idea for new or improved behavior.
17+
title: "<brief summary of the proposed feature>"
18+
labels: ["type: feature request"]
19+
20+
body:
21+
- type: markdown
22+
attributes:
23+
value: |
24+
Thanks for helping us improve! 🙏 Please answer these questions and provide as much information as possible about your feature request.
25+
26+
- id: preamble
27+
type: checkboxes
28+
attributes:
29+
label: Prerequisites
30+
description: |
31+
Please run through the following list and make sure you've tried the usual "quick fixes":
32+
options:
33+
- label: "Search the [current open issues](https://github.com/googleapis/mcp-toolbox-sdk-go/issues)"
34+
required: true
35+
36+
- type: textarea
37+
id: use-case
38+
attributes:
39+
label: What are you trying to do that currently feels hard or impossible?
40+
description: "A clear and concise description of what the end goal for the feature should be -- avoid generalizing and try to provide a specific use-case."
41+
validations:
42+
required: true
43+
44+
- type: textarea
45+
id: suggested-solution
46+
attributes:
47+
label: Suggested Solution(s)
48+
description: "If you have a suggestion for how this use-case can be solved, please feel free to include it."
49+
50+
- type: textarea
51+
id: alternatives-considered
52+
attributes:
53+
label: Alternatives Considered
54+
description: "Are there any workaround or third party tools to replicate this behavior? Why would adding this feature be preferred over them?"
55+
56+
- type: textarea
57+
id: additional-details
58+
attributes:
59+
label: Additional Details
60+
description: "Any additional information we should know? Please reference it here (issues, PRs, descriptions, or screenshots)"
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Copyright 2025 Google LLC
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# https://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
15+
name: 💬 Question
16+
description: Questions on how something works or the best way to do something?
17+
title: "<brief summary of the question>"
18+
labels: ["type: question"]
19+
20+
body:
21+
- type: markdown
22+
attributes:
23+
value: |
24+
Thanks for helping us improve! 🙏 Please provide as much information as possible about your question.
25+
26+
- id: preamble
27+
type: checkboxes
28+
attributes:
29+
label: Prerequisites
30+
description: |
31+
Please run through the following list and make sure you've tried the usual "quick fixes":
32+
options:
33+
- label: "Search the [current open issues](https://github.com/googleapis/genai-toolbox/issues)"
34+
required: true
35+
36+
- type: textarea
37+
id: question
38+
attributes:
39+
label: Question
40+
description: "What's your question? Please provide as much relevant information as possible to reduce turnaround time. Include information like what environment, language, or framework you are using."
41+
placeholder: "Example: How do I use Toolbox SDKs with my own orchestration framework?"
42+
validations:
43+
required: true
44+
45+
- type: textarea
46+
id: code
47+
attributes:
48+
label: Code
49+
description: "Please paste any useful application code that might be relevant to your question. (if your code is in a public repo, feel free to paste a link!)"
50+
51+
- type: textarea
52+
id: additional-details
53+
attributes:
54+
label: Additional Details
55+
description: "Any other information you want us to know that might be helpful in answering your question? (link issues, PRs, descriptions, or screenshots)."

.github/ISSUE_TEMPLATE/support_request.md

Lines changed: 0 additions & 7 deletions
This file was deleted.

0 commit comments

Comments
 (0)