Skip to content

Latest commit

 

History

History
59 lines (47 loc) · 1.26 KB

CONTRIBUTING.md

File metadata and controls

59 lines (47 loc) · 1.26 KB
Raw

Contributing

The files to modify are under the src folder. src/assets are JavaScript files written in es6 that get compiled through babel into lib/sitemapper.js.

Build

To build the lib directory with the compiled assets use this command

npm run build

This uses Babel to compile the files. Make sure to run npm run build before submitting a pull request.

# Run examples/index.js
npm start

Testing

Make sure all tests pass using

npm test

This will run Mocha for testing and ESLint for style guides The tests run will be mocha and eslint. Make sure your style follows the style guide in .eslintrc

Style Guide

To see if your code passes the linter use

npm run lint

Pull Requests

Be sure to build your code with npm run build before making a pull request. Pull requests will use TravisCI to run your code. If you would like to be an owner of this repository to approve pull requests, create an issue that I will review.

Structure

lib/
  assets/
    sitemapper.js
  examples/
    index.js
  tests/
    test.js
src/
  assets/
    sitemapper.js
  examples/
    index.js
  tests/
    test.js