Skip to content

Commit 8106fb2

Browse files
Add CONTRIBUTING.md
1 parent e8a368d commit 8106fb2

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

.github/workflows/CONTRIBUTING.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Contributing
2+
3+
Thank you for your interest in contributing to this project! We appreciate your help in making this project better.
4+
5+
## Testing Changes
6+
7+
Before submitting your pull request, please ensure that your changes do not break the build. To test your changes:
8+
9+
1. Run the following command in the root folder of the project to build the demo applications:
10+
11+
```bash
12+
npm run build:js:public
13+
```
14+
15+
2. After the build process is successful, try to host the project locally using a tool like [`http-server`](https://npmjs.com/http-server):
16+
17+
```bash
18+
http-server docs/
19+
```
20+
21+
3. Open your web browser and navigate to `http://localhost:8080` (or the port specified by `http-server`) to view the hosted project. Click through the generated applications and make sure they work.
22+
23+
## Submitting Changes
24+
25+
Once you have made and tested your changes:
26+
27+
1. Commit your changes with a descriptive commit messages.
28+
2. Push your changes and create a PR summarizing the changes you've made.
29+
3. Wait for an approval and then **squash-merge** to the `main`, the CD will take care of the deployment process.
30+
4. Make sure the deployment job was successfull by visiting `https://getstream.io/chat/demos`, test your changes there as well. Unsuccessful jobs won't publish, debug accordingly.

0 commit comments

Comments
 (0)