Skip to content

Commit 167340f

Browse files
Aryamanz29Aryamanz29
committed
APP-6437 | Added issue and pull request templates
1 parent 2be3780 commit 167340f

File tree

4 files changed

+176
-0
lines changed

4 files changed

+176
-0
lines changed

‎.github/ISSUE_TEMPLATE/BUG-REPORT.yaml

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
name: "🐛 Bug Report"
2+
description: File a bug report for the SDK.
3+
title: "🐛 [BUG] - <title>"
4+
labels: ["bug"]
5+
6+
body:
7+
- type: textarea
8+
id: description
9+
attributes:
10+
label: "🐞 Description"
11+
description: Clear and concise description of the issue.
12+
placeholder: What went wrong?
13+
validations:
14+
required: true
15+
16+
- type: input
17+
id: reprod-url
18+
attributes:
19+
label: "🔗 Reproduction Repo/Script (if any)"
20+
description: Link to a minimal repo or script that reproduces the issue.
21+
placeholder: https://github.com/your/repo
22+
validations:
23+
required: false
24+
25+
- type: textarea
26+
id: reprod
27+
attributes:
28+
label: "📋 Reproduction Steps"
29+
description: Steps to reproduce the bug.
30+
value: |
31+
1. Import SDK
32+
2. Call method `...`
33+
3. Observe error `...`
34+
render: bash
35+
validations:
36+
required: true
37+
38+
- type: textarea
39+
id: logs
40+
attributes:
41+
label: "🪵 Logs / Tracebacks"
42+
description: Paste any relevant logs or error messages here (no need for backticks).
43+
render: bash
44+
validations:
45+
required: false
46+
47+
- type: textarea
48+
id: expected
49+
attributes:
50+
label: "✅ Expected vs 🧨 Actual"
51+
description: What was the expected behavior and what actually happened?
52+
validations:
53+
required: true
54+
55+
- type: dropdown
56+
id: environment
57+
attributes:
58+
label: "💻 Environment"
59+
description: What environment are you running this in?
60+
options:
61+
- MacOS
62+
- Linux
63+
- Windows
64+
- Other (mention in description)
65+
validations:
66+
required: false
67+
68+
- type: input
69+
id: sdk-version
70+
attributes:
71+
label: "📦 SDK Version"
72+
description: What version of the SDK are you using?
73+
placeholder: e.g. 0.5.1
74+
validations:
75+
required: true

‎.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yaml

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
name: "💡 Feature Request"
2+
description: Suggest a new feature or enhancement for the SDK.
3+
title: "💡 [REQUEST] - <title>"
4+
labels: ["enhancement"]
5+
6+
body:
7+
- type: textarea
8+
id: summary
9+
attributes:
10+
label: "📝 Summary"
11+
description: Briefly describe the proposed feature.
12+
placeholder: What would you like to see added or improved?
13+
validations:
14+
required: true
15+
16+
- type: textarea
17+
id: example
18+
attributes:
19+
label: "💡 Basic Example"
20+
description: Provide a simple code snippet or example of how this feature would work.
21+
placeholder: Share a code example or expected usage.
22+
validations:
23+
required: true
24+
25+
- type: textarea
26+
id: motivation
27+
attributes:
28+
label: "🎯 Motivation"
29+
description: What problem does this feature solve or what use case does it support?
30+
placeholder: Why is this feature needed?
31+
validations:
32+
required: true
33+
34+
- type: textarea
35+
id: drawbacks
36+
attributes:
37+
label: "⚠️ Drawbacks"
38+
description: Any potential downsides, risks, or performance impacts?
39+
placeholder: Be honest and neutral about what this might affect.
40+
validations:
41+
required: false
42+
43+
- type: textarea
44+
id: unresolved
45+
attributes:
46+
label: "❓ Unresolved Questions"
47+
description: Are there any open questions or decisions to be made?
48+
placeholder: Anything unclear about how to approach this?
49+
validations:
50+
required: false
51+
52+
- type: textarea
53+
id: references
54+
attributes:
55+
label: "🔗 Reference Issues / PRs"
56+
description: Link to any related issues or pull requests.
57+
placeholder: e.g. #123, #456
58+
validations:
59+
required: false

‎.github/ISSUE_TEMPLATE/config.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: true

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# ✨ Description
2+
3+
Briefly explain the purpose of this PR and what it covers. Mention any related issues or Jira tickets.
4+
5+
**Jira link:** _[Insert link here]_
6+
7+
---
8+
9+
## 🧩 Type of change
10+
11+
Select all that apply:
12+
13+
- [ ] 🚀 New feature (non-breaking change that adds functionality)
14+
- [ ] 🐛 Bug fix (non-breaking change that fixes an issue) — please include tests! Refer [testing-toolkit 🧪](https://developer.atlan.com/toolkits/testing)
15+
- [ ] 🔄 Refactor (code change that neither fixes a bug nor adds a feature)
16+
- [ ] 🧹 Maintenance (chores, cleanup, minor improvements)
17+
- [ ] 💥 Breaking change (fix or feature that may break existing functionality)
18+
- [ ] 📦 Dependency upgrade/downgrade
19+
- [ ] 📚 Documentation updates
20+
21+
---
22+
23+
## ✅ How has this been tested? (e.g. screenshots, logs, workflow links)
24+
25+
Describe how the change was tested. Include:
26+
27+
- Steps to reproduce
28+
- Any relevant screenshots, logs, or links to successful workflow runs
29+
- Details on environment/setup if applicable
30+
31+
---
32+
33+
## 📋 Checklist
34+
35+
- [ ] My code follows the project’s style guidelines
36+
- [ ] I’ve performed a self-review of my code
37+
- [ ] I’ve added comments in tricky or complex areas
38+
- [ ] I’ve updated the documentation as needed
39+
- [ ] There are no new warnings from my changes
40+
- [ ] I’ve added tests to cover my changes
41+
- [ ] All new and existing tests pass locally

0 commit comments

Comments
 (0)