CONTRIBUTION.md

Table Of Contents

Code of Conduct

Styleguides

• Git Commit Messages
• Raise a Pull Request
• JavaScript Styleguide
• HTML Styleguide

Code of Conduct

All developers contributing to this project abide by the Code of Conduct defined for this project. Violations should be reported at neelp1543@gmail.com. Please follow these steps to have your contribution considered by the maintainers:

Styleguides

Git Commit Messages

• Add the issue number in your commit messages

      git commit -m "<your message> #issue_number"
  

• Use the present tense ("Add feature" not "Added feature")
• Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
• Limit the first line to 72 characters or less
• Reference issues and pull requests liberally after the first line
• When only changing documentation, include [ci skip] in the commit title
• Attach issue id in the commit message for easier tracking

Raise a Pull Request

• Raise a pull request to be merged with meaningful name.
• Using the issue name may be a good option.
• Refer the issue numbers in the description of the request. (Use #issue_number to reference the issue)
• For example see #28
• Pull request must be approved by 2 or more reviewers before being merged into master.

JavaScript Styleguide

All JavaScript must adhere to JavaScript Standard Style.

• Prefer the object spread operator ({...anotherObj}) to Object.assign()
• Inline exports with expressions whenever possible

  // Use this:
  export default class ClassName {
  
  }
  
  // Instead of:
  class ClassName {
  
  }
  export default ClassName

• Place requires in the following order:
  • Built in Node Modules (such as path)
  • Built in Atom and Electron Modules (such as atom, remote)
  • Local Modules (using relative paths)
• Place class properties in the following order:
  • Class methods and properties (methods starting with static)
  • Instance methods and properties
• Avoid platform-dependent code
• All files must end in a new line

HTML Styleguide

All HTML must adhere to HTML Standard Style.

• Use HTTPS for embedded resources where possible.
• Indent by 2 spaces at a time.
  • Don’t use tabs or mix tabs and spaces for indentation.
• Use only lowercase.
• Remove trailing white spaces.
• Make sure your editor uses UTF-8 as character encoding, without a byte order mark.
• HTML5 (HTML syntax) is preferred for all HTML documents: .
• Use valid HTML where possible.
• Provide alternative contents for multimedia.
• Separate structure from presentation from behavior.
• Do not use entity references.
• Use a new line for every block, list, or table element, and indent every such child element.

JS DOC Styleguide

• Learn more about JS Doc style guide here.
• Document every JavaScript function by adding JSDoc comments above the function definition with the following tags:
  • @summary can use Markdown here
  • @param {type} name description, use [] square brackets around param for optional params
  • @return {type} name description, or @return {undefined}
• Functions use the following comment style in JSDoc:

  /**
  Takes 2 numbers and returns their sum.
  @param   {number} a     the first number
  @param   {number} b     the second number
  @param   {number} [c=0] the optional third number
  
  @returns {number} the sum of a and b
  */
  function addNumbers(a, b, c) {
  if (typeof c === "undefined") {
      c = 0;
  }
  return a + b + c;
  }