-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #9 from fortmatic/ajen_issue_5_bug_feature_pr_ques…
…tion_tmpl Add bug, feature, question and pr templates
- Loading branch information
Showing
4 changed files
with
111 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
--- | ||
name: Bug Report | ||
about: Use this template to report a bug. | ||
title: "[DESCRIPTIVE BUG NAME]" | ||
labels: 🐛 Bug Report, 🔍 Needs Triage | ||
--- | ||
|
||
### ✅ Prerequisites | ||
|
||
- [ ] Did you perform a cursory search of open issues? Is this bug already reported elsewhere? | ||
- [ ] Are you running the latest SDK version? | ||
- [ ] Are you reporting to the correct repository (`magic-admin-python`)? | ||
|
||
### 🐛 Description | ||
|
||
[Description of the bug.] | ||
|
||
### 🧩 Steps to Reproduce | ||
|
||
1. [First Step] | ||
2. [Second Step] | ||
3. [and so on...] | ||
|
||
### 🤔 Expected behavior | ||
|
||
[What you expected to happen?] | ||
|
||
### 😮 Actual behavior | ||
|
||
[What actually happened? Please include any error stack traces you encounter.] | ||
|
||
### 💻 Code Sample | ||
|
||
[If possible, please provide a code repository, gist, code snippet or sample files to reproduce the issue.] | ||
|
||
### 🌎 Environment | ||
|
||
| Software | Version(s) | | ||
| ------------------- | ---------- | | ||
| `magic-admin-python`| | | ||
| `python` | | | ||
| Operating System | | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
--- | ||
name: Feature Request | ||
about: Use this template to request a new feature. | ||
title: "[DESCRIPTIVE FEATURE NAME]" | ||
labels: ✨Feature Request | ||
--- | ||
|
||
### ✅ Prerequisites | ||
|
||
- [ ] Did you perform a cursory search of open issues? Is this feature already requested elsewhere? | ||
- [ ] Are you reporting to the correct repository (`magic-admin-python`)? | ||
|
||
### ✨ Feature Request | ||
|
||
[Description of the feature.] | ||
|
||
## 🧩 Context | ||
|
||
[Explain any additional context or rationale for this feature. What are you trying to accomplish?] | ||
|
||
## 💻 Examples | ||
|
||
[Do you have any example(s) for the requested feature? If so, describe/demonstrate your example(s) here.] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
--- | ||
name: Question | ||
about: Use this template to request help or ask a question. | ||
title: "[WHAT'S YOUR QUESTION?]" | ||
labels: ❓Question | ||
--- | ||
|
||
### ✅ Prerequisites | ||
|
||
- [ ] Did you perform a cursory search of open issues? Is this question already asked elsewhere? | ||
- [ ] Are you reporting to the correct repository (`magic-admin-sdk`)? | ||
|
||
### ❓ Question | ||
|
||
[Ask your question here, please be as detailed as possible!] | ||
|
||
### 🌎 Environment | ||
|
||
| Software | Version(s) | | ||
| ------------------- | ---------- | | ||
| `magic-admin-python`| | | ||
| `python` | | | ||
| Operating System | | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
### 📦 Pull Request | ||
|
||
[Provide a general summary of the pull request here.] | ||
|
||
### 🗜 Versioning | ||
|
||
(Check _one!_) | ||
|
||
- [ ] Patch: Bug Fix? | ||
- [ ] Minor: New Feature? | ||
- [ ] Major: Breaking Change? | ||
|
||
### ✅ Fixed Issues | ||
|
||
- [List any fixed issues here like: Fixes #XXXX] | ||
|
||
### 🚨 Test instructions | ||
|
||
[Describe any additional context required to test the PR/feature/bug fix.] | ||
|
||
### ⚠️ Update `CHANGELOG.md` | ||
|
||
- [ ] I have updated the `Upcoming Changes` section of `CHANGELOG.md` with context related to this Pull Request. |