Skip to content

Commit 3366630

Browse files
haxziehaxzie
authored
Feat: Add issue templates (#2120)
1 parent e2c38c3 commit 3366630

File tree

6 files changed

+251
-0
lines changed

6 files changed

+251
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug-report.yml‎

Lines changed: 136 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,136 @@
1+
name: "🐞 Bug Report"
2+
description: "Report a bug or unexpected behavior in the Composio TypeScript or Python SDK"
3+
title: "[Bug]: <Short description>"
4+
labels: ["bug", "needs-triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
## 🐞 Bug Report
10+
Thanks for taking the time to report a bug! Please provide as much detail as possible to help us investigate and fix it quickly.
11+
12+
- type: dropdown
13+
id: sdk_language
14+
attributes:
15+
label: "SDK Language"
16+
description: "Which Composio SDK are you using?"
17+
options:
18+
- TypeScript / Node.js SDK (`@composio/core`)
19+
- Python SDK (`composio` package)
20+
- Both
21+
- Not sure
22+
default: 0
23+
validations:
24+
required: true
25+
26+
- type: input
27+
id: sdk_version
28+
attributes:
29+
label: "SDK Version"
30+
description: "Version of the SDK (e.g., @composio/[email protected] or composio==0.1.7)"
31+
placeholder: "@composio/[email protected] or composio==0.1.7"
32+
validations:
33+
required: true
34+
35+
- type: input
36+
id: runtime_env
37+
attributes:
38+
label: "Runtime Environment"
39+
description: "Specify Node.js or Python version, plus platform if relevant"
40+
placeholder: |
41+
Node.js v20.10.0 on macOS 14.2
42+
or
43+
Python 3.11 on Ubuntu 22.04
44+
validations:
45+
required: true
46+
47+
- type: dropdown
48+
id: environment
49+
attributes:
50+
label: "Environment"
51+
description: "Where did this issue occur?"
52+
options:
53+
- Local Development
54+
- Production Deployment
55+
- Cloudflare Worker
56+
- Vercel / Serverless Function
57+
- Other
58+
default: 0
59+
validations:
60+
required: true
61+
62+
- type: textarea
63+
id: description
64+
attributes:
65+
label: "Describe the Bug"
66+
description: "What happened? What did you expect to happen instead?"
67+
placeholder: |
68+
When executing `composio.tools.execute('GITHUB_GET_REPO')`, it throws a 401 even with a valid token.
69+
Expected: repository details to be returned.
70+
validations:
71+
required: true
72+
73+
- type: textarea
74+
id: reproduction_steps
75+
attributes:
76+
label: "Steps to Reproduce"
77+
description: "Please include exact steps or code to reproduce the issue"
78+
placeholder: |
79+
1. Initialize Composio
80+
2. Authorize GitHub
81+
3. Call `composio.tools.execute('GITHUB_GET_REPO', {...})`
82+
4. Observe 401 error
83+
validations:
84+
required: true
85+
86+
- type: textarea
87+
id: code_snippet
88+
attributes:
89+
label: "Minimal Reproducible Example"
90+
description: "Paste code or commands to reproduce (use correct language block)"
91+
placeholder: |
92+
```typescript
93+
import { Composio } from '@composio/core';
94+
95+
const composio = new Composio({ apiKey: process.env.COMPOSIO_API_KEY });
96+
const result = await composio.tools.execute('GITHUB_GET_REPO', {
97+
userId: 'default',
98+
arguments: { owner: 'composio', repo: 'sdk' },
99+
});
100+
```
101+
```python
102+
from composio import Composio
103+
104+
composio = Composio(api_key="YOUR_API_KEY")
105+
result = composio.tools.execute("GITHUB_GET_REPO", user_id="default", arguments={"owner": "composio", "repo": "sdk"})
106+
```
107+
render: shell
108+
109+
- type: textarea
110+
id: error_logs
111+
attributes:
112+
label: "Error Output / Stack Trace"
113+
description: "Paste the full error output or traceback"
114+
render: shell
115+
placeholder: |
116+
Error: [ComposioError] Unauthorized request
117+
File "sdk/tools.py", line 82, in execute
118+
raise ExecutionFailed("Unauthorized request")
119+
validations:
120+
required: true
121+
122+
- type: checkboxes
123+
id: reproducibility
124+
attributes:
125+
label: "Reproducibility"
126+
description: "How consistently does the bug occur?"
127+
options:
128+
- label: "Always reproducible"
129+
- label: "Intermittent / Sometimes"
130+
- label: "Happened once, can’t reproduce"
131+
132+
- type: textarea
133+
id: additional_context
134+
attributes:
135+
label: "Additional Context or Screenshots"
136+
description: "Add logs, screenshots, or related issues if available"

‎.github/ISSUE_TEMPLATE/feature-request.yml‎

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
name: "🚀 Feature Request"
2+
description: "Suggest a new feature or improvement for the Composio SDKs, Dashboard, or Integrations"
3+
title: "[Feature]: <Short description>"
4+
labels: ["feature-request", "enhancement"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
## 🚀 Feature Request
10+
Have an idea that can make Composio better? Please describe it below as clearly as possible.
11+
The more context you give, the easier it is for us to prioritize and implement!
12+
13+
- type: dropdown
14+
id: area
15+
attributes:
16+
label: "Area of Improvement"
17+
description: "Which part of Composio does this request relate to?"
18+
options:
19+
- TypeScript / Node.js SDK
20+
- Python SDK
21+
- Dashboard (app.composio.dev)
22+
- Integrations / Toolkits
23+
- MCP Server / Agentic Providers
24+
- Other
25+
default: 0
26+
validations:
27+
required: true
28+
29+
- type: input
30+
id: feature_title
31+
attributes:
32+
label: "Feature Name"
33+
description: "Short descriptive name for the feature"
34+
placeholder: "Add support for GitLab toolkit"
35+
validations:
36+
required: true
37+
38+
- type: textarea
39+
id: feature_description
40+
attributes:
41+
label: "Describe the Feature"
42+
description: "What would you like to see added or improved?"
43+
placeholder: |
44+
I’d love to see a GitLab toolkit added to Composio SDK so I can list projects, issues, and merge requests directly from my AI agent.
45+
validations:
46+
required: true
47+
48+
- type: textarea
49+
id: use_case
50+
attributes:
51+
label: "Use Case / Motivation"
52+
description: "Explain why this feature is valuable. What problem does it solve?"
53+
placeholder: |
54+
- My AI agent needs to interact with GitLab repositories.
55+
- I want to automate PR creation and review workflows.
56+
validations:
57+
required: true
58+
59+
- type: textarea
60+
id: proposed_solution
61+
attributes:
62+
label: "Proposed Solution or API Design (Optional)"
63+
description: "How would you like this to work? Feel free to propose SDK methods or UI ideas."
64+
placeholder: |
65+
Example (TypeScript):
66+
```typescript
67+
const gitlabTools = await composio.tools.get('default', { toolkits: ['gitlab'] });
68+
await composio.tools.execute('GITLAB_CREATE_ISSUE', { userId, arguments: {...} });
69+
```
70+
71+
- type: checkboxes
72+
id: impact_scope
73+
attributes:
74+
label: "Who does this impact?"
75+
options:
76+
- label: "Developers using the SDK"
77+
- label: "AI Agent frameworks (LangChain, OpenAI, etc.)"
78+
- label: "Dashboard users"
79+
- label: "End users of connected apps"
80+
81+
- type: textarea
82+
id: related_issues
83+
attributes:
84+
label: "Related Issues / References"
85+
description: "Link any related GitHub issues, docs, or external resources"
86+
placeholder: "#42, https://developers.gitlab.com/api/reference"
87+
88+
- type: checkboxes
89+
id: willingness
90+
attributes:
91+
label: "Would you like to contribute to this feature?"
92+
options:
93+
- label: "Yes, I can help implement it"
94+
- label: "Maybe, I can help test or review"
95+
- label: "No, just sharing the idea"
96+
97+
- type: textarea
98+
id: additional_context
99+
attributes:
100+
label: "Additional Context"
101+
description: "Any extra information, mockups, or screenshots"

‎.github/workflows/ts.build.yml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,11 @@ name: Build Typescript SDK
33
on:
44
push:
55
branches: [main]
6+
paths:
7+
- "ts/**"
68
pull_request:
9+
paths:
10+
- "ts/**"
711

812
jobs:
913
build:

‎.github/workflows/ts.release.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ on:
44
workflow_dispatch:
55
push:
66
branches: [next]
7+
paths:
8+
- "ts/**"
79

810
env:
911
GITHUB_ACCESS_TOKEN: ${{ secrets.CI_BOT_TOKEN }}

‎.github/workflows/ts.test.yml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,12 @@ name: Test Typescript SDK
33
on:
44
push:
55
branches: [main, next]
6+
paths:
7+
- "ts/**"
68
pull_request:
79
branches: [main, next]
10+
paths:
11+
- "ts/**"
812

913
jobs:
1014
test:

‎.github/workflows/ts.typecheck.yml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,12 @@ name: Typecheck Typescript SDK
33
on:
44
push:
55
branches: [main, next]
6+
paths:
7+
- "ts/**"
68
pull_request:
79
branches: [main, next]
10+
paths:
11+
- "ts/**"
812

913
jobs:
1014
typecheck:

0 commit comments

Comments
 (0)