Contributing to Rocket.Chat

:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:

The following is a set of guidelines for contributing to Rocket.Chat and its packages, which are hosted in the Rocket.Chat Organization on GitHub.

Note: If there's a feature you'd like, there's a bug you'd like to fix, or you'd just like to get involved please raise an issue and start a conversation. We'll help as much as we can so you can get contributing - although we may not always be able to respond right away :)

Coding standards

Most of the coding standards are covered by .editorconfig and .eslintrc.

We acknowledge all the code does not meet these standards but we are working to change this over time.

Syntax check

Before submitting a PR you should get no errors on eslint.

To check your files, run:

yarn lint

Branching Model

Pull requests target dev, the default branch. master holds only released code — it only moves forward via a dev→master release merge. release/X.Y.x branches are patch lines for a shipped stable version, maintained by cherry-picking fixes from dev; only backport PRs for an already-released version should target one of these.

See docs/development-and-release-flow.md for the full picture of how a change moves from PR to release.

Contributor License Agreement

Please review and sign our CLA.