Skip to content

Latest commit

 

History

History
59 lines (38 loc) · 1.43 KB

CONTRIBUTING.md

File metadata and controls

59 lines (38 loc) · 1.43 KB
Raw

Contributing

We are open to, and grateful for, any contributions made by the community. By contributing to axios, you agree to abide by the code of conduct.

Code Style

Please follow the node style guide.

Commit Messages

Commit messages should be verb based.

  • Fixing ...
  • Adding ...
  • Updating ...
  • Removing ...

Testing

Please update the tests to reflect your code changes. Pull requests will not be accepted if they are failing on Travis CI.

Documentation

Please update the docs accordingly so that there are no discrepencies between the API and the documentation.

Developing

  • grunt test run the jasmine and nodeunit tests
  • grunt build run webpack and bundle the source
  • grunt publish prepare the code for release
  • grunt watch:test watch for changes and run test
  • grunt watch:build watch for changes and run build

Please don't include changes to dist/ in your pull request. This should only be updated when releasing a new version.

Running Examples

Examples are included in part to allow manual testing.

Running example

$ npm run examples
# Open 127.0.0.1:3000

Running sandbox in browser

$ npm start
# Open 127.0.0.1:3000

Running sandbox in terminal

$ npm start
$ node ./sandbox/client