Skip to content

Latest commit

 

History

History
253 lines (168 loc) · 10.4 KB

CONTRIBUTING.md

File metadata and controls

253 lines (168 loc) · 10.4 KB
Raw

Contributing to Rocket.Chat

First off, thanks for taking the time to contribute! 🎉👍

There are many ways to contribute to Rocket.Chat even if you're not technical or a developer:

Every bit of contribution is appreciated 🙂 thank you!

The following is a set of guidelines for contributing to Rocket.Chat, 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 :)

Setup

Your development workstation needs to have at least 8GB RAM or more to be able to build the Rocket.Chat's source code.

Rocket.Chat runs on top of Meteor. To run it on development mode you need to install Meteor and clone/download the Rocket.Chat's code, then just open the code folder and run:

meteor npm install && meteor

It should build and run the application and database for you, now you can access the UI on (http://localhost:3000)

It's not necessary to install Nodejs or NPM, every time you need to use them you can run meteor node or meteor npm.

It's important to always run the NPM commands using meteor npm to ensure that you are installing the modules using the right Nodejs version.

Coding

We provide a .editorconfig file that will help you to keep some standards in place.

ECMAScript vs TypeScript

We are currently adopting TypeScript as the default language on our projects, the current codebase will be migrated incrementally from JavaScript to TypeScript.

While we still have a lot of JavaScript files you should not create new ones. As much as possible new code contributions should be in TypeScript.

Blaze vs React

We are currently adopting React over Blaze as our UI engine, the current codebase is under migration and will continue. You will still find Blaze templates in our code. Code changes or contributions may need to be made in Blaze while we continue to evolve our components library.

Fuselage is our component library based on React, check it out when contributing to the Rocket.Chat UI and feel free to contribute new components or fixes.

Standards

Most of the coding standards are covered by ESLint configured at .eslintrc, and most of them came from our own ESLint Config Package.

Things not covered by eslint:

  • Prefer longer/descriptive variable names, e.g. error vs err, unless dealing with common record properties already shortened, e.g. rid and uid
  • Use return early pattern. See more
  • Prefer Promise over callbacks
  • Prefer await over then/catch
  • Don't create queries outside models, the query description should be inside the model class.
  • Don't hardcode fields inside models. Same method can be used for different purposes, using different fields.
  • Prefer create REST endpoints over Meteor methods
  • Prefer call REST endpoints over Meteor methods when both are available
  • v1 REST endpoints should follow the following pattern: /api/v1/dashed-namespace.camelCaseAction
  • Prefer TypeScript over JavaScript. Check ECMAScript vs TypeScript

Blaze

  • Import the HTML file from it's sibling JS/TS file

Syntax check

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

To check your files run:

meteor npm run lint

Tests

There are 2 types of tests we run on Rocket.Chat, Unit tests and End to End tests. The major difference is that End to End tests require a Rocket.Chat instance running to execute the API and UI checks.

End to End Tests

First you need to run a Rocket.Chat server on Test Mode and on a Empty Database:

# Running with a local mongodb database
MONGO_URL=mongodb://localhost/empty MONGO_OPLOG_URL=mongodb://localhost/local TEST_MODE=true meteor
# Running with a local mongodb database but cleaning it before
mongo --eval "db.dropDatabase()" empty && MONGO_URL=mongodb://localhost/empty MONGO_OPLOG_URL=mongodb://localhost/local TEST_MODE=true meteor

Now you can run the tests:

meteor npm test

Unit Tests

Unit tests are simpler to setup and run. They do not require a working Rocket.Chat instance.

meteor npm run testunit

It's possible to run on watch mode as well:

meteor npm run testunit-watch

Before Push your code

It's important to run the lint and tests before push your code or submit a Pull Request, otherwise your contribution may fail quickly on the CI. Reviewers are forced to demand fixes and the review of your contribution will be further delayed.

Rocket.Chat uses husky to run the lint and unit tests before proceed to the code push process, so you may notice a delay when pushing your code to your repository.

Choosing a good PR title

It is very important to note that we use PR titles when creating our change log. Keep this in mind when you title your PR. Make sure the title makes sense to a person reading a releases' change log!

Keep your PR's title as short and concise as possible, use PR's description section, which you can find in the PR's template, to provide more details into the changelog.

Good titles require thinking from a user's point of view. Don't get technical and talk code or architecture. What is the actual user-facing feature or the bug fixed? For example:

[NEW] Allow search permissions and settings by name instead of only ID

Even it's being something new in the code the users already expect the filter to filter by what they see (translations), a better one would be:

[FIX] Permissions' search doesn't filter base on presented translation, only on internal ids

Choosing the right PR tag

You can use several tags do describe your PR, i.e.: [FIX], [NEW], etc. You can use the descriptions below to better understand the meaning of each one, and decide which one you should use:

[NEW]

When

  • When adding a new feature that is important to the end user

How

Do not start repeating the section (Add ... or New ...) Always describe what's being fixed, improved or added and not how it was fixed, improved or added.

Exemple of bad PR titles:

[NEW] Add ability to set tags in the Omnichannel room closing dialog
[NEW] Adds ability for Rocket.Chat Apps to create discussions
[NEW] Add MMS support to Voxtelesys
[NEW] Add Color variable to left sidebar

Exemple of good PR titles:

[NEW] Ability to set tags in the Omnichannel room closing dialog
[NEW] Ability for Rocket.Chat Apps to create discussions
[NEW] MMS support to Voxtelesys
[NEW] Color variable to left sidebar

[FIX]

When

  • When fixing something not working or behaving wrong from the end user perspective

How

Always describe what's being fixed and not how it was fixed.

Exemple of a bad PR title:

[FIX] Add Content-Type for public files with JWT

Exemple of a good PR title:

[FIX] Missing Content-Type header for public files with JWT

[IMPROVE]

When

  • When a change enhances a not buggy behavior. When in doubt if it's a Improve or Fix prefer to use as fix.

How

Always describe what's being improved and not how it was improved.

Exemple of good PR title:

[IMPROVE] Displays Nothing found on admin sidebar when search returns nothing

[BREAK]

When

  • When the changes affect a working feature
Back-End
  • When the API contract (data structure and endpoints) are limited, expanded as required or removed
  • When the business logic (permissions and roles) are limited, expanded (without migration) or removed
Front-End
  • When the change limits (format, size, etc) or removes the ability of read or change the data (when the limitation was not caused by the back-end)

Second tag e.g. [NEW][ENTERPRISE]

Use a second tag to group entries on the change log, we currently use it only for the Enterprise items but we are going to expand it's usage soon, please do not use it until we create a patter for it.

Minor Changes

For those PRs that aren't important for the end user, we are working on a better pattern, but for now please use the same tags, use them without the brackets and in camel case:

Fix: Missing Content-Type header for public files with JWT

All those PRs will be grouped under the Minor changes section which is collapsed, so users can expand it to check for those minor things but they are not visible directly on changelog.

Security Best Practices

  • Never expose unnecessary data to the APIs' responses
  • Always check for permissions or create new ones when you must expose sensitive data
  • Never provide new APIs without rate limiters
  • Always escape the user's input when rendering data
  • Always limit the user's input size on server side
  • Always execute the validations on the server side even when executing on the client side as well

Performance Best Practices

  • Prefer inform the fields you want, and only the necessary ones, when querying data from database over query the full documents
  • Limit the number of returned records to a reasonable value
  • Check if the query is using indexes, if it's not create new indexes
  • Prefer queues over long executions
  • Create new metrics to mesure things whenever possible
  • Cache data and returns whenever possible

Contributor License Agreement

To have your contribution accepted you must sign our Contributor License Agreement. In case you submit a Pull Request before sign the CLA GitHub will alert you with a new comment asking you to sign and will block the Pull Request from be merged by us.

Please review and sign our CLA at https://cla-assistant.io/RocketChat/Rocket.Chat