Is there a coding standards doc for Rocket.Chat?

[shrop]

Just looking for Rocket.Chat coding standards doc so my team can contribute. Thanks!

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

[kakawait]

Should create a more common document like CONTRIBUTING.md that cover coding style, processes, tricks and other useful things for developers.

👍

Actually there is just a https://github.com/RocketChat/Rocket.Chat/blob/master/.editorconfig

[gmsecrieru]

Thanks for your interest! I think that haven't been started yet. Would you be willing to kick-off a document? There are lots of things we could standardise, maybe we could just start by tracking them.

[kakawait]

@gmsecrieru You/We can copy CONTRIBE.md from other famous project and adapt as base

[geekgonecrazy]

Any good examples of very well done contribute.md?

I think this is a very needed dicussion. We do need to standardize the coding style.

We shouldn't let this prevent us, but this could be effected by #1015

[kakawait]

@geekgonecrazy yeah when I spoke about CONTRIBUTE.md is for structure/format only! You should write your own standard.

ATM I don't have sample CONTRIBUTE.md but I will check on top project (https://github.com/trending)!

[kakawait]

My 2 cents datamining I found Angular CONTRIBUTING.md file pretty complete (but maybe too many) https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md

[shrop]

Here are a few examples:
https://github.com/blog/1184-contributing-guidelines
https://github.com/atom/atom/blob/master/CONTRIBUTING.md
https://github.com/puppetlabs/puppet/blob/master/CONTRIBUTING.md
Not a github style, but complete for a project: https://www.drupal.org/contribute

I am happy to help contribute to this task!

[shrop]

Also, https://github.com/meteor/meteor/wiki/Meteor-Style-Guide :)
https://github.com/meteor/meteor/blob/devel/Contributing.md

[gmsecrieru]

👍 this is a great contribution!

[shrop]

Thanks @gmsecrieru. I am starting a Quip document that can be a start and get in to a PR as a start. Contributing.md can easily be added to and changed from there, so we just need a solid start that the project leads agree fits Rocket.Chat coding and overall philosophy.

[shrop]

@gmsecrieru 2 tabs for indentions is a Rocket.Chat style I can add to the doc?

[gmsecrieru]

I would say so.

[shrop]

Formatting standards like this may be helpful: https://github.com/polarmobile/coffeescript-style-guide

[kakawait]

It's my 2 cents point of view but when working with community we should create a standard documentation and above all use tools like linter (#1195), coding style checker to ensure new PR respect standard.

[gmsecrieru]

+1

[shrop]

@kakawait couldn't agree more

[karlprieb]

Any update?

[engelgabriel]

Started at https://rocket.chat/docs/developer-guides/code-styleguide

@MartinSchoeler please add a NodeJS section.

[paulovitin]

@geekgonecrazy and @graywolf336 about the discussion of how to check the presence of property in object.

The bug in code is by no checking if user contains roles property, so a send a PR using a secure check of property in an object using ESLint recommendation:

if(Object.hasOwnProperty.call(user, 'roles') && Array.isArray(user.roles)) {
}

But, for not being so clear of understand and no according to code style, we agree to use like this:

if(user.roles && Array.isArray(user.roles)) {
}

But this can cause some side effects if we checking a property and this property has a false value. We need do the things most safety way possible.

So I believe this approach can be better using destructuring and checking the type of property, like this:

// this dont throw error if user not has property roles
// roles in this case will be undefined
const { roles } = user;

if(Array.isArray(roles)) {
} 

Is most readable and good styling.

[rodrigok]

@paulovitin IMO, there is no need to check if roles property exists and then check the property type, you could check the type directly:

if(Array.isArray(user.roles)) {
...
}

[paulovitin]

@rodrigok you are right. 👍

[marceloschmidt]

We currently use eslint to validate coding style, and our CI will not allow PR without passing the rules. Please check https://github.com/RocketChat/eslint-config-rocketchat