Skip to content

Commit d7d7595

Browse files
bordumbclaude
bordumb
and
claude
authored
docs: add GitHub issue templates (#8)
* docs: add CONTRIBUTING.md Comprehensive contributing guide covering: - Bug reporting and feature requests - Development setup with uv - Branch naming and commit message conventions - Pull request process - Code style (ruff, mypy, pre-commit) - Testing guidelines - Documentation standards - Project structure overview Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * docs: add GitHub issue templates Add structured issue templates: - Bug report with reproduction steps, code examples, version info - Feature request with use case, API design, component selection - Question template for usage help - Config to disable blank issues and add contact links Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 1e38c15 commit d7d7595

4 files changed

Lines changed: 242 additions & 0 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
name: Bug Report
2+
description: Report a bug or unexpected behavior
3+
title: "[Bug]: "
4+
labels: ["bug", "triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for reporting a bug! Please fill out the information below to help us investigate.
10+
11+
- type: textarea
12+
id: description
13+
attributes:
14+
label: Description
15+
description: A clear and concise description of the bug.
16+
placeholder: What happened?
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: reproduction
22+
attributes:
23+
label: Steps to Reproduce
24+
description: Minimal steps to reproduce the behavior.
25+
placeholder: |
26+
1. Create a BondAgent with...
27+
2. Call agent.ask(...)
28+
3. See error...
29+
validations:
30+
required: true
31+
32+
- type: textarea
33+
id: expected
34+
attributes:
35+
label: Expected Behavior
36+
description: What did you expect to happen?
37+
validations:
38+
required: true
39+
40+
- type: textarea
41+
id: actual
42+
attributes:
43+
label: Actual Behavior
44+
description: What actually happened? Include error messages and stack traces if applicable.
45+
validations:
46+
required: true
47+
48+
- type: textarea
49+
id: code
50+
attributes:
51+
label: Minimal Reproducible Example
52+
description: If possible, provide a minimal code example that reproduces the issue.
53+
render: python
54+
placeholder: |
55+
from bond import BondAgent
56+
57+
agent = BondAgent(
58+
name="test",
59+
instructions="You are helpful.",
60+
model="openai:gpt-4o",
61+
)
62+
63+
# This causes the bug...
64+
result = await agent.ask("Hello")
65+
66+
- type: dropdown
67+
id: version
68+
attributes:
69+
label: Bond Version
70+
description: What version of bond-agent are you using?
71+
options:
72+
- "0.1.2 (latest)"
73+
- "0.1.1"
74+
- "0.1.0"
75+
- "main branch"
76+
- "Other (specify in description)"
77+
validations:
78+
required: true
79+
80+
- type: dropdown
81+
id: python
82+
attributes:
83+
label: Python Version
84+
options:
85+
- "3.12"
86+
- "3.11"
87+
- "Other"
88+
validations:
89+
required: true
90+
91+
- type: dropdown
92+
id: os
93+
attributes:
94+
label: Operating System
95+
options:
96+
- "macOS"
97+
- "Linux"
98+
- "Windows"
99+
- "Other"
100+
validations:
101+
required: true
102+
103+
- type: textarea
104+
id: additional
105+
attributes:
106+
label: Additional Context
107+
description: Add any other context about the problem here.

‎.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: Documentation
4+
url: https://renbytes.github.io/bond-agent/
5+
about: Check the documentation for guides and API reference
6+
- name: Discussions
7+
url: https://github.com/renbytes/bond-agent/discussions
8+
about: Ask questions and share ideas in GitHub Discussions

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
name: Feature Request
2+
description: Suggest a new feature or enhancement
3+
title: "[Feature]: "
4+
labels: ["enhancement"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for suggesting a feature! Please describe your idea below.
10+
11+
- type: textarea
12+
id: problem
13+
attributes:
14+
label: Problem or Use Case
15+
description: What problem are you trying to solve? What use case does this enable?
16+
placeholder: |
17+
I'm trying to build an agent that...
18+
Currently I have to work around this by...
19+
validations:
20+
required: true
21+
22+
- type: textarea
23+
id: solution
24+
attributes:
25+
label: Proposed Solution
26+
description: Describe your proposed solution or feature.
27+
placeholder: |
28+
It would be great if BondAgent could...
29+
validations:
30+
required: true
31+
32+
- type: textarea
33+
id: api
34+
attributes:
35+
label: API Design (Optional)
36+
description: If you have thoughts on the API, share them here.
37+
render: python
38+
placeholder: |
39+
# Example of how the feature might work
40+
agent = BondAgent(
41+
name="assistant",
42+
new_feature=True, # New option
43+
)
44+
45+
- type: textarea
46+
id: alternatives
47+
attributes:
48+
label: Alternatives Considered
49+
description: Any alternative solutions or features you've considered?
50+
51+
- type: dropdown
52+
id: component
53+
attributes:
54+
label: Component
55+
description: Which part of Bond does this relate to?
56+
options:
57+
- "Core (BondAgent, streaming)"
58+
- "Server (SSE, WebSocket)"
59+
- "Tools - GitHub"
60+
- "Tools - GitHunter"
61+
- "Tools - Memory"
62+
- "Tools - Schema"
63+
- "Tools - New toolset"
64+
- "Trace/Observability"
65+
- "Documentation"
66+
- "Other"
67+
validations:
68+
required: true
69+
70+
- type: checkboxes
71+
id: contribution
72+
attributes:
73+
label: Contribution
74+
description: Would you be interested in contributing this feature?
75+
options:
76+
- label: I'd be willing to submit a PR for this feature

‎.github/ISSUE_TEMPLATE/question.yml‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: Question
2+
description: Ask a question about using Bond
3+
title: "[Question]: "
4+
labels: ["question"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Have a question about using Bond? We're happy to help!
10+
11+
**Before asking:**
12+
- Check the [documentation](https://renbytes.github.io/bond-agent/)
13+
- Search [existing issues](https://github.com/renbytes/bond-agent/issues)
14+
15+
- type: textarea
16+
id: question
17+
attributes:
18+
label: Question
19+
description: What would you like to know?
20+
validations:
21+
required: true
22+
23+
- type: textarea
24+
id: context
25+
attributes:
26+
label: Context
27+
description: What are you trying to accomplish? Any relevant code or configuration?
28+
render: python
29+
30+
- type: textarea
31+
id: tried
32+
attributes:
33+
label: What I've Tried
34+
description: What have you already tried or looked at?
35+
36+
- type: dropdown
37+
id: topic
38+
attributes:
39+
label: Topic
40+
options:
41+
- "Getting started / Installation"
42+
- "BondAgent configuration"
43+
- "Streaming / StreamHandlers"
44+
- "Server setup (SSE/WebSocket)"
45+
- "Using tools (GitHub, Memory, etc.)"
46+
- "Creating custom tools"
47+
- "Tracing / Observability"
48+
- "Testing"
49+
- "Other"
50+
validations:
51+
required: true

0 commit comments

Comments
 (0)