We are open to, and grateful for, any contributions made by the community. By contributing to newque, you agree to abide by the code of conduct.
Please follow the node style guide.
Commit messages should be verb based, using the following pattern:
Fixing ...Adding ...Updating ...Removing ...
Please update the tests to reflect your code changes. Pull requests will not be accepted if they are failing on Travis CI.
Please update the docs accordingly so that there are no discrepencies between the API and the documentation.
In order to start developing, you will need to install the zeromq library in your environment. This can be done using homebrew on a mac. To install homebrew follow:
ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" < /dev/null 2> /dev/null
To install zeromq:
brew install zeromq
The test suite requires a running Newque server. The easiest way to get started is to fire up the docker image:
docker run -v $(pwd)/conf:/newque/conf -p 8000:8000 -p 8001:8001 -p 8005:8005 -p 8006:8006 -p 8007:8007 -d -t newque/newque
npm run testrun the mocha and chai tests
Please don't include changes to dist/ in your pull request. This should only be updated when releasing a new version.
Releasing a new version is mostly automated. For now the CHANGELOG requires being updated manually. Once this has been done run the commands below. Versions should follow semantic versioning.
npm version <newversion> -m "Releasing %s"npm publish
Examples are included in part to allow manual testing.
Running example
$ npm run examples
# Open 127.0.0.1:3000Running sandbox in browser
$ npm start
# Open 127.0.0.1:3000Running sandbox in terminal
$ npm start
$ node ./sandbox/client