Skip to content

Commit 755d02a

Browse files
Merge pull request #1528 from GetStream/develop
v8.1.1
2 parents 89bf72a + a52ffeb commit 755d02a

37 files changed

+1305
-194
lines changed

.env.example

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,4 @@ E2E_TEST_USER_2='test-user-2'
66
E2E_TEST_USER_2_TOKEN='test-user-2-jwt'
77
E2E_JUMP_TO_MESSAGE_CHANNEL='jump-to-message'
88
E2E_ADD_MESSAGE_CHANNEL='add-message'
9+
E2E_ADDITIONAL_CHANNELS="mr-channel-1,mr-channel-2"
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: 'bug:'
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
12+
A clear and concise description of what the bug is.
13+
14+
**To Reproduce**
15+
16+
Steps to reproduce the behavior:
17+
1. Go to '...'
18+
2. Click on '....'
19+
3. Scroll down to '....'
20+
4. See error
21+
22+
**Expected behavior**
23+
24+
A clear and concise description of what you expected to happen.
25+
26+
**Screenshots**
27+
28+
If applicable, add screenshots to help explain your problem.
29+
30+
**Package version**
31+
- stream-chat-react:
32+
- stream-chat-css:
33+
- stream-chat-js:
34+
35+
**Desktop (please complete the following information):**
36+
37+
- OS: [e.g. iOS]
38+
- Browser [e.g. chrome, safari]
39+
- Version [e.g. 22]
40+
41+
**Smartphone (please complete the following information):**
42+
43+
- Device: [e.g. iPhone6]
44+
- OS: [e.g. iOS8.1]
45+
- Browser [e.g. stock browser, safari]
46+
- Version [e.g. 22]
47+
48+
**Additional context**
49+
50+
Add any other context about the problem here.

.github/auto-merge.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
minApprovals:
2+
NONE: 0
3+
requiredLabels:
4+
- stream-dependencies
5+
updateBranch: true
6+
mergeMethod: rebase
7+
deleteBranchAfterMerge: true
8+
requiredTitleRegex: stream-chat-css

.github/dependabot.yml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: 'npm'
4+
directory: '/'
5+
schedule:
6+
interval: 'daily'
7+
allow:
8+
- dependency-name: '@stream-io/stream-chat-css'
9+
- dependency-name: 'stream-chat'
10+
labels:
11+
- stream-dependencies

.github/workflows/ci.yml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,16 +25,16 @@ jobs:
2525
runs-on: ubuntu-latest
2626
name: End-to-end tests
2727
steps:
28-
- uses: actions/checkout@v2
28+
- uses: actions/checkout@v3
2929

3030
- name: 💾 Cache Dependencies
31-
uses: actions/cache@v2
31+
uses: actions/cache@v3
3232
with:
3333
path: ./node_modules
3434
key: ${{ runner.os }}-${{ matrix.node }}-modules-${{ hashFiles('**/yarn.lock') }}
3535

3636
- name: 🔨 Install Dependencies & Build
37-
run: yarn install --frozen-lockfile --ignore-engines
37+
run: yarn install --frozen-lockfile --ignore-engines --ignore-scripts
3838

3939
- name: ⚗️ End-to-end tests
4040
run: |
@@ -54,6 +54,7 @@ jobs:
5454
E2E_APP_SECRET: ${{ secrets.E2E_APP_SECRET }}
5555
E2E_TEST_USER_1_TOKEN: ${{ secrets.E2E_TEST_USER_1_TOKEN }}
5656
E2E_TEST_USER_2_TOKEN: ${{ secrets.E2E_TEST_USER_2_TOKEN }}
57+
E2E_ADDITIONAL_CHANNELS: mr-channel-1, mr-channel-2
5758

5859
test:
5960
runs-on: ubuntu-latest

.releaserc.json

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,12 @@
88
"changelogFile": "./CHANGELOG.md"
99
}
1010
],
11-
"@semantic-release/github",
11+
[
12+
"@semantic-release/github",
13+
{
14+
"assets": ["./CHANGELOG.md"]
15+
}
16+
],
1217
"@semantic-release/npm"
1318
]
1419
}

CHANGELOG.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,29 @@
11
# Changelog
22

3+
## [8.1.0](https://github.com/GetStream/stream-chat-react/compare/v8.0.0...v8.1.0) (2022-04-08)
4+
5+
6+
### Bug Fixes
7+
8+
* adjust links to stories used by add-message e2e tests ([c6dc53a](https://github.com/GetStream/stream-chat-react/commit/c6dc53ae18c0b03905a1f05452bcec6a610a6ca5))
9+
* autocomplete items clicking works on webkit ([#1494](https://github.com/GetStream/stream-chat-react/issues/1494)) ([4f73f14](https://github.com/GetStream/stream-chat-react/commit/4f73f145b877419a4d745c96f8b0096ac5a52ac3))
10+
* correct german calendar translation strings ([#1468](https://github.com/GetStream/stream-chat-react/issues/1468)) ([2471d4b](https://github.com/GetStream/stream-chat-react/commit/2471d4bcd227c7c7991d5791bd304409605349ac)), closes [#1467](https://github.com/GetStream/stream-chat-react/issues/1467)
11+
* fixed connection handling, updated configuration ([0face10](https://github.com/GetStream/stream-chat-react/commit/0face104ba81c3ca6495e63132af003a90228cc9))
12+
* improve portuguese translations ([5e67a86](https://github.com/GetStream/stream-chat-react/commit/5e67a865a8211956c3a86980cc2896f4e3f059ff))
13+
* improved German translations ([c4d71b6](https://github.com/GetStream/stream-chat-react/commit/c4d71b6f5b2e07ace0ee7644664ebabff2526138))
14+
* improved German translations ([a6fe4fb](https://github.com/GetStream/stream-chat-react/commit/a6fe4fbed906c102728bb18f97fee21f978f322a))
15+
* Slow mode role check and limitations ([a447ed5](https://github.com/GetStream/stream-chat-react/commit/a447ed5b2945e7f669d414ed820c2585bbdd04e9))
16+
* Update channel preview on connection recovery ([92f81d9](https://github.com/GetStream/stream-chat-react/commit/92f81d9831e6c84501550ee259939d872a2c66a5))
17+
* Update quoted message preview on message update ([#1503](https://github.com/GetStream/stream-chat-react/issues/1503)) ([f9a0081](https://github.com/GetStream/stream-chat-react/commit/f9a0081af3576f187883f649cf0a1f807b47ee44))
18+
* update unread counts for each ChannelPreview on WS connection recovery ([b267a65](https://github.com/GetStream/stream-chat-react/commit/b267a65c31ac97ee60d3a2681b26cfc610501a38))
19+
* Upload preview overflow in thread ([#1495](https://github.com/GetStream/stream-chat-react/issues/1495)) ([518d622](https://github.com/GetStream/stream-chat-react/commit/518d622f8b716a6c622a65816eae16f50e9545e5))
20+
21+
22+
### Features
23+
24+
* support jump to message ([#1478](https://github.com/GetStream/stream-chat-react/issues/1478)) ([e297ffe](https://github.com/GetStream/stream-chat-react/commit/e297ffed906bd24ba68698cf704f9d08610d1314))
25+
26+
327
## [8.0.0](https://github.com/GetStream/stream-chat-react/releases/tag/v7.0.0) 2022-03-17
428

529
### Bug Fixes

CONTRIBUTING.md

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
# Contributing to stream-chat-react
2+
3+
As a contributor, here are the guidelines we would like you to follow:
4+
5+
- [Asking questions](#asking-questions)
6+
- [Filing an issue](#filing-an-issue)
7+
- [Contribution Standards](#coding-standards)
8+
- [Submission Guidelines](#submission-guidelines)
9+
- [Signing the CLA](#contributor-licence-agreement)
10+
11+
12+
## <a name="asking-questions"></a>Are you looking for answers?
13+
There are many ways you can get your questions answered. It can be hard to decide, where to begin if you are just starting out. We suggest you take a look at the resources in the following order:
14+
15+
### 1. Stream chat API documentation
16+
Package `stream-chat-react` has a peer dependency [stream-chat-js](https://github.com/GetStream/stream-chat-js) - a client library for interacting with the Stream Chat API (see the [API docs](https://getstream.io/chat/docs/javascript/?language=javascript)).
17+
18+
### 2. Documentation for stream-chat-react
19+
The [stream-chat-react](https://getstream.io/chat/docs/sdk/react/) documentation is held separately from the Stream Chat API docs. Besides documenting the component API, it provides examples of their use in various scenarios.
20+
21+
### 3. Read the source code
22+
When you plan on contributing to the repository try to get acquainted with the existing code base. The best way to learn :)
23+
24+
### 4. Take a look at our tutorials
25+
26+
27+
### Get help from our Customer Success team
28+
If what you are looking for is technical support embedding Stream in your application, we suggest emailing our Customer Success team at [email protected] with your application key and the SDK versions you're using. The Issue section of this GitHub repo is now reserved only for bug reports, feature improvements and suggestions.
29+
30+
31+
## <a name="filing-an-issue"></a>Filing an issue
32+
Spotting imperfections and not keeping them to yourself is the first step to make this library better. We are very grateful for reports concerning imperfections in the source code or the [documentation]((https://getstream.io/chat/docs/sdk/react/)). Before filing an issue, please, review the list of [open issues](https://github.com/GetStream/stream-chat-react/issues) first.
33+
34+
### Reporting bugs
35+
You can report a source code bug by using the [Bug Report template](https://github.com/GetStream/stream-chat-react/issues/new/choose). Make sure you include "steps to reproduce" section. Bug that cannot be reproduced cannot be solved.
36+
37+
Do not be afraid to report imperfections in our [documentation]((https://getstream.io/chat/docs/sdk/react/)) as well. In such case, please attach the `docs` tag to the issue.
38+
39+
40+
### Requesting a feature
41+
You can request a feature by submitting a [Feature request issue](https://github.com/GetStream/stream-chat-react/issues/new?assignees=&labels=feature&template=feature_request.md&title=) in our repository. If you would like to implement the proposal, please state it in the issue. It will allow us to discuss the proposal and better coordinate the efforts. You can even ping us - mention `@GetStream/stream-react-developers ` in the issue.
42+
43+
## <a name="contribution-standards"></a> Contributing to the repo
44+
45+
### Set up for success
46+
It is always good to get acquainted with the specifics of the package. For example the `stream-chat-react` package has its peer dependencies (`stream-chat-js`, `stream-chat-css`), which you may need to tweak at the same time, while developing the feature for `stream-chat-react`. To get more into those specifics, please read [development guide](./developers/DEVELOPMENT.md).
47+
48+
### Good first issue
49+
50+
###<a name="#coding-rules"></a> Coding rules
51+
Any contributions to the library should follow Stream's coding rules.
52+
53+
#### 1. Code should be tested
54+
All the code submitted should be covered by unit tests. Mocking utilities are provided in `src/mock-builders`. Optimally a suite of E2E tests should be included as well.
55+
56+
#### 2. API Changes should be documented
57+
Changes to components interface exposed to the library integrators should be documented. We keep the documentation `docusaurus/docs/React` folder.
58+
59+
#### 3. Code should be DRY & correctly formatted
60+
If you find yourself copying source code from one place to another, please extract it into a separate component or function.
61+
62+
#### 4. Keep an eye on performance
63+
Keep in mind that the chat application may need to work with thousands of messages.
64+
65+
#### 5. Follow commit formatting rules
66+
We follow [Angular's Commit Message Format rules](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-commit-message-format) with [possible deviations](./developers/COMMIT.md). The same rules are used by our release automation tool. Therefore, every commit message should strictly comply with these rules.
67+
68+
69+
## <a name="submission-guidelines"></a> Submitting your work
70+
1. Make sure you have signed our Contributor License agreement
71+
2. [Fork](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo) the repo and create a dedicated git branch locally
72+
3. Follow the [coding rules](#coding-rules)
73+
4. Create a descriptive PR ([see more on PR requirements](./developers/PR_REVIEW.md))
74+
75+
76+
## <a name="contributor-licence-agreement"></a> Contributor License Agreement
77+
Before we can merge your contribution into our repository, we would like to ask you to sign the [Contributor License Agreement](https://docs.google.com/forms/d/e/1FAIpQLScFKsKkAJI7mhCr7K9rEIOpqIDThrWxuvxnwUq2XkHyG154vQ/viewform).
78+

commitlint.config.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
module.exports = {
2+
extends: ['@commitlint/config-conventional']
3+
};

developers/BRANCHES.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Branches
2+
We have 2 protected (base) branches:
3+
4+
- `develop`
5+
- `master`
6+
7+
If you want to implement a solution, you are required to create branches from `develop` or its derivatives.
8+
9+
The `develop` branch serves as a reservoir of bug fixes and new features waiting to be released.
10+
11+
The `master` branch serves for release and should receive updates only from the `develop` branch.
12+
13+
So the branch architecture in this repository is as follows:
14+
15+
```shell
16+
NPM <--- master <--- develop <--- branch_solution_x
17+
<--- branch_solution_y
18+
<--- branch_solution_x
19+
...
20+
```

0 commit comments

Comments
 (0)