Skip to content

Commit

Permalink
Create Issue Templates (#24)
Browse files Browse the repository at this point in the history
  • Loading branch information
AshutoshAJ authored Sep 16, 2024
2 parents d5aea16 + 24d9ea8 commit 38460c0
Show file tree
Hide file tree
Showing 4 changed files with 208 additions and 0 deletions.
75 changes: 75 additions & 0 deletions .github/ISSUE_TEMPLATE/BUG_REPORT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
---
name: 🐛 Bug Report
about: If something isn't working as expected 🤔
title: '[Bug]: Short summary of the issue'
labels: 'bug'


---


## Bug Description

_A clear and concise description of what the bug is._


### New Issue Checklist

- [ ] Updated IOS SDK to the latest version
- [ ] I read the [Contribution Guidelines](https://github.com/finbox-in/device-connect-ios-sdk/blob/master/CONTRIBUTING.md)
- [ ] I searched for [existing GitHub issues](https://github.com/finbox-in/device-connect-ios-sdk/issues)


### Expected Behavior

_Describe what you expected to happen._


### Current Behavior

_Describe what actually happened. Include error messages, if any._


### Steps to Reproduce

1. Open App
2. Sync Data
3. Check in `...` class
4. Check the `...` function


### Screenshots

_If applicable, add screenshots to help explain your problem._


### Logs & Stack Trace

_Please include relevant log messages and stack traces, especially any errors or exceptions._


### Device

<!--
Please help us understand the details about the device where the issue is happening.
-->

- Brand: [e.g. Apple]
- Model: [e.g. iPhone Pro 16, iPhone Mini 12]
- OS: [e.g. 15.8.3, 16.1, 17]


### Environment

<!--
Please help us understand if the issue is happening on UAT/DEV/PROD.
-->

- [ ] DEV
- [ ] UAT
- [ ] PROD


**Additional context**

Add any other context about the problem here.
53 changes: 53 additions & 0 deletions .github/ISSUE_TEMPLATE/FEATURE_REQUEST.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
---
name: 🚀 Feature Request
about: Suggest a new feature or improvement for the Android project
title: '[Feature]: Brief description of the feature'
labels: 'enhancement'

---

## 🚀 Feature Request

_A clear and concise description of the feature or improvement you are suggesting._


### New Issue Checklist

- [ ] Updated IOS SDK to the latest version
- [ ] I read the [Contribution Guidelines](https://github.com/finbox-in/device-connect-ios-sdk/blob/master/CONTRIBUTING.md)
- [ ] I searched for [existing GitHub issues](https://github.com/finbox-in/device-connect-ios-sdk/issues)


### Problem Statement

_Describe the problem or challenge this feature will solve. Why is it important?_


### Proposed Solution

_Describe how you would like this feature to work. Be as detailed as possible._


### Alternatives Considered (optional)

_Did you consider any alternative solutions? If yes, briefly describe them and why they are not the best option._


### Additional Information

_Add any other relevant details, context, or references that would help in implementing this feature._


### Screenshots or Mockups (optional)

_If applicable, add mockups or sketches to show what the feature could look like._


### Benefits

_How will this feature improve the project or user experience?_


### Risks or Dependencies (optional)

_Are there any potential risks, trade-offs, or dependencies that should be considered?_
74 changes: 74 additions & 0 deletions .github/ISSUE_TEMPLATE/REGRESSION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
---
name: 🔄 Regression Issue
about: Report an issue that was previously working but is now broken
title: '[Regression]: Brief summary of the issue'
labels: 'regression'

---


## 🔄 Regression Description

_A clear and concise description of the issue that has regressed. What was working before that is now broken?_


### New Issue Checklist

- [ ] Updated IOS SDK to the latest version
- [ ] I read the [Contribution Guidelines](https://github.com/finbox-in/device-connect-ios-sdk/blob/master/CONTRIBUTING.md)
- [ ] I searched for [existing GitHub issues](https://github.com/finbox-in/device-connect-ios-sdk/issues)


### Previous Version

_Specify the version(s) of the app or codebase where the feature was working as expected (e.g., SDK v1.0.0, Commit SHA, or branch name)._


### Current Version

_Specify the current version where the regression is happening (e.g., SDK v1.1.0, Commit SHA, or branch name)._


### Expected Behavior

_Describe the expected behavior that was observed in the previous version._


### Current Behavior

_Describe the behavior you are seeing now. Include any error messages or unexpected behavior._


### Steps to Reproduce

1. Open App
2. Sync Data
3. Check in `...` class
4. Check the `...` function


### Device

<!--
Please help us understand the details about the device where the issue is happening.
-->

- Brand: [e.g. Apple]
- Model: [e.g. iPhone Pro 16, iPhone Mini 12]
- OS: [e.g. 15.8.3, 16.1, 17]


### Environment

<!--
Please help us understand if the issue is happening on UAT/DEV/PROD.
-->

- [ ] DEV
- [ ] UAT
- [ ] PROD


### Logs & Stack Trace

_Include any relevant log messages and stack traces, especially for errors or exceptions._
6 changes: 6 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
blank_issues_enabled: false

contact_links:
- name: Report Security Vulnerability
url: mailto:srikar@finbox.in
about: Please report security vulnerabilities here.

0 comments on commit 38460c0

Please sign in to comment.