Skip to content

Latest commit

 

History

History
50 lines (37 loc) · 2.03 KB

CONTRIBUTING.md

File metadata and controls

50 lines (37 loc) · 2.03 KB
Raw

Contributing to Vue-Chimera

  1. Fork this repository to your own GitHub account and then clone it to your local device.
  2. Run npm install to install the dependencies.

Note that both npm and yarn have been seen to miss installing dependencies. To remedy that, you can either delete the node_modules folder in your example app and install again or do a local install of the missing dependencies.

Running test suites

yarn test

Pull Requests

  • Fill in the required template
  • Do not include issue numbers in the PR title
  • Include screenshots and animated GIFs in your pull request whenever possible.
  • Follow the JavaScript and CoffeeScript styleguides.
  • Include thoughtfully-worded, well-structured Jasmine specs in the ./spec folder. Run them using atom --test spec. See the Specs Styleguide below.
  • Document new code based on the Documentation Styleguide
  • End all files with a newline
  • Avoid platform-dependent code
  • 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 a @ in CoffeeScript or static in JavaScript)
    • Instance methods and properties

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