Skip to content

Commit b601553

Browse files
author
Chojan Shang
committed
chore: add github templates
Signed-off-by: Chojan Shang <chojan.shang@vesoft.com>
1 parent d84a0d3 commit b601553

File tree

4 files changed

+162
-0
lines changed

4 files changed

+162
-0
lines changed
Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
name: Bug Report
2+
description: Tell us about a regression or defect in the ACP Python SDK.
3+
title: "bug: "
4+
labels: ["bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: >
9+
Thanks for filing a detailed bug. Fill out every section so we can
10+
reproduce the issue quickly and keep the SDK solid.
11+
12+
- type: textarea
13+
id: summary
14+
attributes:
15+
label: Summary
16+
description: What went wrong? Keep it short but specific.
17+
placeholder: "Streaming updates stop after the second prompt…"
18+
validations:
19+
required: true
20+
21+
- type: textarea
22+
id: repro
23+
attributes:
24+
label: Reproduction steps
25+
description: >
26+
Commands, code, or payloads that trigger the bug. Include any relevant
27+
input files or snippets (redact secrets).
28+
validations:
29+
required: true
30+
31+
- type: textarea
32+
id: expected
33+
attributes:
34+
label: Expected result
35+
placeholder: "Tool call should finish and emit a completed status…"
36+
validations:
37+
required: true
38+
39+
- type: textarea
40+
id: actual
41+
attributes:
42+
label: Actual result
43+
placeholder: "Agent hangs and no further session/update payloads arrive…"
44+
validations:
45+
required: true
46+
47+
- type: input
48+
id: versions
49+
attributes:
50+
label: Versions / environment
51+
description: >
52+
Include SDK version, ACP schema tag (if pinned), Python version, and OS.
53+
placeholder: "sdk 0.5.1 (schema v0.4.7), Python 3.12.2 on macOS 14.4"
54+
validations:
55+
required: true
56+
57+
- type: textarea
58+
id: logs
59+
attributes:
60+
label: Logs & screenshots
61+
description: Paste relevant stack traces, JSON snippets, or console output.
62+
render: shell
63+
64+
- type: checkboxes
65+
id: willing-to-pr
66+
attributes:
67+
label: Open to submitting a fix?
68+
options:
69+
- label: I’m willing to open a PR for this bug.

.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: false
2+
contact_links:
3+
- name: Ask a question
4+
url: https://github.com/agentclientprotocol/python-sdk/discussions/new?category=q-a
5+
about: Usage questions, architecture ideas, and doc clarifications live best in Discussions.
6+
- name: Read the docs
7+
url: https://agentclientprotocol.github.io/python-sdk/
8+
about: The published docs cover quickstart steps, contrib helpers, and release workflows.
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
name: Feature Request
2+
description: Pitch an improvement for the ACP Python SDK docs, runtime, or tooling.
3+
title: "feat: "
4+
labels: ["enhancement"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: >
9+
Feature requests work best when they focus on the problem first. Tell us
10+
what you’re trying to achieve and why existing APIs aren’t enough.
11+
12+
- type: textarea
13+
id: problem
14+
attributes:
15+
label: Problem statement
16+
description: >
17+
What use case is blocked? Include relevant transports, helpers, or user
18+
journeys.
19+
placeholder: "Need a helper to batch tool call updates when streaming…"
20+
validations:
21+
required: true
22+
23+
- type: textarea
24+
id: proposal
25+
attributes:
26+
label: Proposed solution
27+
description: >
28+
Sketch the API or behaviour you’d like to see. Code snippets welcome.
29+
validations:
30+
required: true
31+
32+
- type: textarea
33+
id: alternatives
34+
attributes:
35+
label: Alternatives considered
36+
description: >
37+
Mention workarounds you’ve tried or other approaches we should weigh.
38+
39+
- type: textarea
40+
id: extra
41+
attributes:
42+
label: Additional context
43+
description: Links, screenshots, related issues, etc.
44+
45+
- type: checkboxes
46+
id: willing-to-help
47+
attributes:
48+
label: Can you help build it?
49+
options:
50+
- label: I can contribute code or docs for this request.

.github/pull_request_template.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
## Summary
2+
3+
<!-- What does this change do? Keep it short. -->
4+
5+
6+
## Related issues
7+
8+
<!--
9+
Link the tracked issue(s) using the GitHub syntax, e.g. "Closes #123".
10+
If the work only partially addresses an issue, use "Relates to #123".
11+
-->
12+
13+
14+
## Testing
15+
16+
<!--
17+
List the checks you ran (e.g. `make check`, `make test`, targeted pytest files, manual CLI steps).
18+
Include output snippets when helpful.
19+
-->
20+
21+
22+
## Docs & screenshots
23+
24+
<!--
25+
Note any documentation or example updates included (or explain why none are needed).
26+
Attach screenshots/GIFs when the change affects UX.
27+
-->
28+
29+
30+
## Checklist
31+
32+
- [ ] Conventional Commit title (e.g. `feat:`, `fix:`).
33+
- [ ] Tests cover the change or are not required (explain above).
34+
- [ ] Docs/examples updated when behaviour is user-facing.
35+
- [ ] Schema regenerations (`make gen-all`) are called out if applicable.

0 commit comments

Comments
 (0)