CONTRIBUTING.md

Contributing

Contributions are appreciated in the form of pull requests. However, to maintain code readability and maintainability, some guidelines have been set. Your pull request will likely be rejected if it does not merge these guidelines, so please read them carefully.

Style

• Although semicolons are optional in JavaScript, please use a semicolon after every statement that would normally use a semicolon in other languages
• Tabs should be replaced with 4 spaces.
• New classes should have their constructor's name explicitly specified, and classes should usually be specified as one per file (with rare exceptions). However, class methods should be anonymously defined with no name. Example:

  function ClassName(argument) {
      this.argument = argument;
  }
  
  module.exports = ClassName;
  
  ClassName.prototype.method = function() {
      ...
  }

• CR-LF line endings should be used (\r\n).
• Please leave a blank line at the end of each file.
• Conditional/loop statements (if, for, while, etc.) should always use braces, and the opening brace should be placed on the same line as the statement.
• There should be a space after a conditional/loop statement and before the condition, as well as a space after the condition and before the brace. Example:

  // Good
  if (condition) {
      ...
  }
  
  // Bad
  if(condition) {
      ...
  }
  
  if(condition){
      ...
  }