Skip to content

Commit 2361547

Browse files
authored
chore: issue & pr templates (#104)
* Add PR template * Add issue templates * Add maintainer blank issue * Update bug_report.yml * Add code owners * Update codeowner * Update feature.yml
1 parent 9809b57 commit 2361547

File tree

6 files changed

+144
-0
lines changed

6 files changed

+144
-0
lines changed

.github/CODEOWNERS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @marandaneto @romtsn @buenaflor

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
name: 🐞 Bug Report
2+
description: Tell us about something that's not working the way we (probably) intend.
3+
labels: ["Platform: KMP", "Type: Bug"]
4+
body:
5+
- type: dropdown
6+
id: environment
7+
attributes:
8+
label: Platform
9+
description: Which platform do you use?
10+
multiple: true
11+
options:
12+
- Apple
13+
- Android
14+
- JVM
15+
validations:
16+
required: true
17+
18+
- type: dropdown
19+
id: installed
20+
attributes:
21+
label: Installed
22+
description: sentry-cocoa installed with (if applicable)
23+
options:
24+
- Swift Package Manager
25+
- CocoaPods
26+
27+
- type: input
28+
id: version
29+
attributes:
30+
label: Version
31+
description: Which version of sentry-kotlin-multiplatform do you use?
32+
placeholder: 0.2.0 ← should look like this
33+
validations:
34+
required: true
35+
36+
- type: textarea
37+
id: repro
38+
attributes:
39+
label: Steps to Reproduce
40+
description: How can we see what you're seeing? Specific is terrific.
41+
placeholder: |-
42+
1. foo
43+
2. bar
44+
3. baz
45+
validations:
46+
required: true
47+
48+
- type: textarea
49+
id: expected
50+
attributes:
51+
label: Expected Result
52+
validations:
53+
required: true
54+
55+
- type: textarea
56+
id: actual
57+
attributes:
58+
label: Actual Result
59+
description: Logs? Screenshots? Yes, please.
60+
validations:
61+
required: true
62+
63+
- type: markdown
64+
attributes:
65+
value: |-
66+
## Thanks 🙏
67+
Check our [triage docs](https://open.sentry.io/triage/) for what to expect next.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Join Sentry Discord
4+
url: https://discord.com/invite/sentry
5+
about: A place to talk about SDK development and other Sentry related topics. It's not meant as a support channel.

.github/ISSUE_TEMPLATE/feature.yml

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: 💡 Feature Request
2+
description: Tell us about a problem our SDK could solve but doesn't.
3+
labels: ["Platform: KMP", "Type: Feature Request"]
4+
body:
5+
- type: textarea
6+
id: problem
7+
attributes:
8+
label: Problem Statement
9+
description: What problem could Sentry solve that it doesn't?
10+
placeholder: |-
11+
I want to make whirled peas, but Sentry doesn't blend.
12+
validations:
13+
required: true
14+
15+
- type: textarea
16+
id: expected
17+
attributes:
18+
label: Solution Brainstorm
19+
description: We know you have bright ideas to share ... share away, friend.
20+
placeholder: |-
21+
Add a blender to Sentry.
22+
validations:
23+
required: false
24+
25+
- type: markdown
26+
attributes:
27+
value: |-
28+
## Thanks 🙏
29+
Check our [triage docs](https://open.sentry.io/triage/) for what to expect next.
30+
validations:
31+
required: false
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: Blank Issue
2+
description: Blank Issue. Reserved for maintainers.
3+
labels: ["Platform: KMP"]
4+
body:
5+
- type: textarea
6+
id: description
7+
attributes:
8+
label: Description
9+
description: Please describe the issue.
10+
validations:
11+
required: true
12+
13+
- type: markdown
14+
attributes:
15+
value: |-
16+
## Thanks 🙏
17+
Check our [triage docs](https://open.sentry.io/triage/) for what to expect next.

.github/pull_request_template.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
## :scroll: Description
2+
3+
<!--- Describe your changes in detail -->
4+
5+
## :bulb: Motivation and Context
6+
7+
<!--- Why is this change required? What problem does it solve? -->
8+
<!--- If it fixes an open issue, please link to the issue here. -->
9+
10+
## :green_heart: How did you test it?
11+
12+
## :pencil: Checklist
13+
14+
You have to check all boxes before merging:
15+
16+
- [ ] I reviewed the submitted code.
17+
- [ ] I added tests to verify the changes.
18+
- [ ] No new PII added or SDK only sends newly added PII if `sendDefaultPII` is enabled.
19+
- [ ] I updated the docs if needed.
20+
- [ ] Review from the native team if needed.
21+
- [ ] No breaking change or entry added to the changelog.
22+
23+
## :crystal_ball: Next steps

0 commit comments

Comments
 (0)