Skip to content

Latest commit

 

History

History
63 lines (40 loc) · 1.53 KB

CONTRIBUTING.md

File metadata and controls

63 lines (40 loc) · 1.53 KB

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, using the following pattern:

  • 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 discrepancies between the API and the documentation.

Developing

  • npm run test run the jasmine and mocha tests
  • npm run build run webpack and bundle the source
  • npm run start run in production mode
  • npm run local run in development mode

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

Deploying to Google Cloud Platform

    ./run_deploy
    open https://stimson-web-curator.uk.r.appspot.com

Running locally

Running production in browser

    cd ~/stimson-web-api
    ./run_docker.sh
    open http://localhost:8080

Running development in browser

    cd ~/stimson-web-api
    ./run_tests.sh
    . .venv/bin/activate
    flask run
    open 127.0.0.1:5000