Skip to content

Latest commit

History

History
56 lines (31 loc) 路 1.83 KB

CONTRIBUTING.md

File metadata and controls

56 lines (31 loc) 路 1.83 KB

Contributing to Stream Chat Swift SDK

We're glad you want to contribute to the Stream team 馃帀


So you...

Got stuck on something 馃挱

Please check stackoverflow and ask your questions there. If your question is not generic, you can send us a support request.

Found a bug 馃悶

Please create a github issue with as much info as possible (follow the Issue Template closely).

Have a feature request 馃搱

Please create a github issue with as much info as possible.

Fixed a bug 馃┕

Please open a PR with as much info as possible: clear description of the problem and the solution. Include the relevant github issue number if applicable.

Make sure Changelog is updated correspondingly (we'll probably change wording but it'll help us immensely)

Before submitting, please make sure you're finished with the PR (and all tests pass) and do not make changes until it's reviewed.

Implemented or changed a feature 馃寛

Guidelines on "Fixed a bug" part is applicable.

Our Release flow 馃殌

We make sure to follow all QA test procedure for minor and major releases.

We accumulate changes and release them in batches, unless high priority. We make sure to put staged changes (on default branch but not released in a version) as "Upcoming" in CHANGELOG.

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.

Local linting of documentation

In case you modify any of our documentation, we require some of our docs to pass a linting step.

To run our doc linting locally:

$ brew install vale
# from the root of our repository
$ vale docusaurus