Skip to content

Commit 4b60db4

Browse files
added templates for PRs and creating issues
1 parent 7827ffb commit 4b60db4

File tree

6 files changed

+141
-0
lines changed

6 files changed

+141
-0
lines changed

β€Ž.github/CODEOWNERS

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @GetStream/ios-developers
+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
## What did you do?
11+
12+
13+
## What did you expect to happen?
14+
15+
16+
## What happened instead?
17+
18+
19+
## GetStream Environment
20+
**GetStream Chat version:**
21+
**GetStream Chat frameworks:** StreamChat, StreamChatSwiftUI
22+
**iOS version:**
23+
**Swift version:**
24+
**Xcode version:**
25+
**Device:**
26+
27+
## Additional context
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
name: Feature Request
3+
about: Got any ideas about new features? Let us know!
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
## What are you trying to achieve?
11+
12+
13+
## If possible, how can you achieve this currently?
14+
15+
16+
## What would be the better way?
17+
18+
19+
## GetStream Environment
20+
**GetStream Chat version:**
21+
**GetStream Chat frameworks:** StreamChat, StreamChatSwiftUI
22+
**iOS version:**
23+
**Swift version:**
24+
**Xcode version:**
25+
**Device:**
26+
27+
## Additional context

β€Ž.github/PULL_REQUEST_TEMPLATE.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
### πŸ”— Issue Link
2+
_Jira or Github issue link, if applicable._
3+
4+
### 🎯 Goal
5+
6+
_Describe why we are making this change._
7+
8+
### πŸ›  Implementation
9+
10+
_Provide a description of the implementation._
11+
12+
### πŸ§ͺ Testing
13+
14+
_Describe the steps how this change can be tested (or why it can't be tested)._
15+
16+
### 🎨 Changes
17+
18+
_Add relevant screenshots or videos showcasing the changes._
19+
20+
### β˜‘οΈ Checklist
21+
22+
- [ ] I have signed the [Stream CLA](https://docs.google.com/forms/d/e/1FAIpQLScFKsKkAJI7mhCr7K9rEIOpqIDThrWxuvxnwUq2XkHyG154vQ/viewform) (required)
23+
- [ ] Changelog is updated with client-facing changes
24+
- [ ] New code is covered by unit tests
25+
- [ ] Affected documentation updated (docusaurus, tutorial, CMS (task created)

β€Ž.github/stale.yml

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Number of days of inactivity before an issue becomes stale
2+
daysUntilStale: 20
3+
# Number of days of inactivity before a stale issue is closed
4+
daysUntilClose: 7
5+
# Issues with these labels will never be considered stale
6+
exemptLabels:
7+
- pinned
8+
- !important
9+
# Label to use when marking an issue as stale
10+
staleLabel: stale
11+
# Comment to post when marking an issue as stale. Set to `false` to disable
12+
markComment: >
13+
This issue has been automatically marked as stale because it has not had
14+
recent activity. It will be closed if no further activity occurs. Thank you
15+
for your contributions.
16+
# Comment to post when closing a stale issue. Set to `false` to disable
17+
closeComment: >
18+
This issue has been automatically closed due to inactivity.
19+
Please open a new issue if it's still valid.

β€ŽCONTRIBUTING.md

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Contributing to Stream Chat SwiftUI SDK
2+
3+
We're glad you want to contribute to the Stream team πŸŽ‰
4+
5+
---
6+
7+
_So you..._
8+
9+
### Got stuck on something πŸ’­
10+
11+
Please check [stackoverflow](https://stackoverflow.com/questions/tagged/getstream-io) and ask your questions there.
12+
If your question is not generic, you can send us a [support request](https://getstream.io/support).
13+
14+
### Found a bug 🐞
15+
16+
Please create a github issue with as much info as possible (follow the Issue Template closely).
17+
18+
### Have a feature request πŸ“ˆ
19+
20+
Please create a github issue with as much info as possible.
21+
22+
### Fixed a bug 🩹
23+
24+
Please open a PR with as much info as possible: clear description of the problem and the solution.
25+
Include the relevant github issue number if applicable.
26+
27+
Make sure Changelog is updated correspondingly (we'll probably change wording but it'll help us immensely)
28+
29+
Before submitting, please make sure you're finished with the PR (and all tests pass) and do not make changes until it's reviewed.
30+
31+
### Implemented or changed a feature 🌈
32+
33+
Guidelines on "Fixed a bug" part is applicable.
34+
35+
## Our Release flow πŸš€
36+
37+
We make sure to follow all QA test procedure for minor and major releases.
38+
39+
We accumulate changes and release them in batches, unless high priority.
40+
We make sure to put staged changes (on default branch but not released in a version) as "Upcoming" in [CHANGELOG](https://github.com/GetStream/stream-chat-swiftui/blob/main/CHANGELOG.md).
41+
42+
If possible, we deprecate stuff before removing them directly. Deprecated stuff will be removed after a minor release, and will include a migration/upgrade guide.

0 commit comments

Comments
Β (0)