Skip to content

Commit 0775d50

Browse files
authored
Merge pull request #13 from BranchMetrics/nsingh-branch-patch-1
Added PR and Issue templates
2 parents 8d999e1 + aef2ca6 commit 0775d50

File tree

4 files changed

+135
-0
lines changed

4 files changed

+135
-0
lines changed
Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
---
2+
assignees: []
3+
body:
4+
-
5+
attributes:
6+
description: "What is the problem? A clear and concise description of what the bug is."
7+
label: "Describe the bug"
8+
placeholder: "Tell us what you see!"
9+
id: description
10+
type: textarea
11+
validations:
12+
required: true
13+
-
14+
attributes:
15+
description: "Please provide as much step-by-step detail as possible including logs, stack traces, and uncaught exceptions."
16+
label: "Steps to reproduce"
17+
value: |
18+
1.
19+
2.
20+
3.
21+
id: steps
22+
type: textarea
23+
validations:
24+
required: true
25+
-
26+
attributes:
27+
description: "What did you expect to happen?"
28+
label: "Expected behavior"
29+
id: expected
30+
type: textarea
31+
validations:
32+
required: true
33+
-
34+
attributes:
35+
description: "What version of sdk are you seeing this issue on?"
36+
label: "SDK Version"
37+
placeholder: "1.43.1"
38+
id: sdk-version
39+
type: input
40+
validations:
41+
required: true
42+
-
43+
attributes:
44+
description: "What version of Xcode are you using?"
45+
label: "XCode Version"
46+
placeholder: "13.4.1"
47+
id: xcode-version
48+
type: input
49+
validations:
50+
required: true
51+
-
52+
attributes:
53+
description: "What devices or emulators are you seeing this bug on?"
54+
label: Device
55+
placeholder: "iPhone 13"
56+
id: device
57+
type: input
58+
validations:
59+
required: true
60+
-
61+
attributes:
62+
description: "What is the version of iOS?"
63+
label: OS
64+
placeholder: "15.6.1"
65+
id: os
66+
type: input
67+
validations:
68+
required: true
69+
-
70+
attributes:
71+
description: "Anything else that might be relevant for troubleshooting this bug. Any screenshots or videos that show the issue are very helpful."
72+
label: "Additional Information/Context"
73+
id: context
74+
type: textarea
75+
validations:
76+
required: false
77+
78+
description: "Found a bug in the Branch iOS SDK? File it here."
79+
labels:
80+
- bug
81+
- needs-triage
82+
name: "🐞 Bug report"
83+
title: "(short issue description)"

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
blank_issues_enabled: false
3+
contact_links:
4+
- name: "📕 Documentation Issue"
5+
url: https://help.branch.io/developers-hub/docs/ios-sdk-overview
6+
about: Report an issue in the Branch iOS SDK Reference documentation by clicking "Suggest edits" button on the documentation page.
7+
- name: "Branch Support"
8+
url: https://help.branch.io/using-branch/page/submit-a-ticket
9+
about: If you are having general trouble with Branch iOS SDK integration, please submit a ticket to Branch Support.
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
name: 🚀 Feature Request
3+
description: Suggest an idea for this project
4+
title: "(short issue description)"
5+
labels: [feature-request, needs-triage]
6+
assignees: []
7+
body:
8+
- type: textarea
9+
id: description
10+
attributes:
11+
label: Describe the feature
12+
description: A clear and concise description of the feature you are proposing.
13+
validations:
14+
required: true

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
## Reference
2+
SDK-XXXX -- <TITLE>.
3+
4+
## Summary
5+
<!-- Simple summary of what was changed. -->
6+
7+
## Motivation
8+
<!-- Why are you making this change? If it's for fixing a bug, if possible, please include a code snippet or example project that demonstrates the issue. -->
9+
10+
## Type Of Change
11+
<!-- Please delete options that are not relevant -->
12+
- [ ] Bug fix (non-breaking change which fixes an issue)
13+
- [ ] New feature (non-breaking change which adds functionality)
14+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
15+
- [ ] This change requires a documentation update
16+
17+
## Testing Instructions
18+
<!-- Testing instructions, example code snippets, etc -->
19+
20+
21+
<!-- Checklist -->
22+
<!-- My code follows the style guidelines of this project -->
23+
<!-- I have performed a self-review of my code -->
24+
<!-- I have commented my code, particularly in hard-to-understand areas -->
25+
<!-- I have made corresponding changes to the documentation -->
26+
<!-- I have added tests that prove my fix is effective or that my feature works -->
27+
<!-- New and existing unit tests pass locally with my changes -->
28+
29+
cc @BranchMetrics/saas-sdk-devs for visibility.

0 commit comments

Comments
 (0)