As a contributor, here are the guidelines we would like you to follow:
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:
Package stream-chat-react has a peer dependency stream-chat-js - a client library for interacting with the Stream Chat API (see the API docs).
The stream-chat-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.
When you plan on contributing to the repository try to get acquainted with the existing code base. The best way to learn :)
If what you are looking for is technical support embedding Stream in your application, we suggest emailing our Customer Success team at support@getstream.io 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.
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. Before filing an issue, please, review the list of open issues first.
You can report a source code bug by using the Bug Report template. Make sure you include "steps to reproduce" section. Bug that cannot be reproduced cannot be solved.
Do not be afraid to report imperfections in our documentation as well. In such case, please attach the docs tag to the issue.
You can request a feature by submitting a Feature request issue 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.
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.
### Coding rules Any contributions to the library should follow Stream's coding rules.
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.
Changes to components interface exposed to the library integrators should be documented. We keep the documentation docusaurus/docs/React folder. Please see the dedicated documentation guide for more information on how to maintain our documentation.
If you find yourself copying source code from one place to another, please extract it into a separate component or function.
Keep in mind that the chat application may need to work with thousands of messages.
We follow Angular's Commit Message Format rules with possible deviations. The same rules are used by our release automation tool. Therefore, every commit message should strictly comply with these rules.
- Make sure you have signed our Contributor License agreement
- Fork the repo and create a dedicated git branch locally
- Follow the coding rules
- Create a descriptive PR (see more on PR requirements)
Before we can merge your contribution into our repository, we would like to ask you to sign the Contributor License Agreement.