Skip to content

Latest commit

 

History

History
76 lines (51 loc) · 1.54 KB

CONTRIBUTING.md

File metadata and controls

76 lines (51 loc) · 1.54 KB
Raw

Contribution Guidelines

Thanks you for considering a contribution to ArsArsenal!

ArsArsenal is built using tools written for nodejs. We recommend installing Node with nvm. Dependencies are managed through package.json.

You can install dependencies with:

npm install

Running

A production build can be built by running:

make build

However most of the time developing with ArsArsenal, you will want to reference the example app:

npm start

This will host a web server with all examples at http://localhost:8080.

Testing

npm test

Be sure to check the ./coverage folder to verify all code paths are touched.

Deployment

The following steps are required to push a new release:

  1. Update changelog
  2. npm version <major,minor,patch>
  3. git push --tags
  4. make release

ArsArsenal must first be compiled down to ES5 using Babel. The following command will perform that task and deploy to NPM:

make release

Conventions

Consider master unsafe, use npm for the latest stable version.

Javascript

ArsArsenal uses ES6 Javascript (compiled using Babel). As for style, shoot for:

  • No semicolons
  • Commas last,
  • 2 spaces for indentation (no tabs)
  • Prefer ' over ", use string interpolation
  • 80 character line length

Reviews

All changes should be submitted through pull request. Ideally, at least two 👍s should be given before a pull request is merge.