babel/CONTRIBUTING.md

NOTE: BEFORE OPENING AN ISSUE PLEASE SEE THE README.

---

Setup | Running tests | Workflow | Dependencies | Code Standards | Internals

---

Contributing

Contributions are always welcome, no matter how large or small. Before contributing, please read the code of conduct.

Developing

Setup

Code Standards

• General

  • Max of five arguments for functions
  • Max depth of four nested blocks
  • 2-spaced soft tabs

• Naming

  • CamelCase all class names
  • camelBack all variable names

• Spacing

  • Spaces after all keywords
  • Spaces before all left curly braces

• Comments

  • Use JSDoc-style comments for methods
  • Single-line comments for ambiguous code

• Quotes

  • Always use double quotes
  • Only use single quotes when the string contains a double quote

• Declaration

  • No unused variables
  • No pollution of global variables and prototypes

Internals

Please see /doc for internals documentation relevant to developing babel.