Skip to content

Contributing

Grant Carthew edited this page Jan 17, 2017 · 2 revisions

Description

Contributing back to the open source community is easy to do. I am happy to accept pull requests that add functionality to the rethinkdb-job-queue project as long as it doesn't add too much overhead or complexity.

Before doing any work on the source code or opening a pull request, consider creating an issue to discuss your idea. Creating an issue would be overkill if it is a simple fix or typo.

Something else to consider is if your idea should be implemented within rethinkdb-job-queue or created as a new project that uses rethinkdb-job-queue as a dependency.

As a final note, be aware that this project uses JavaScript Standard Style for all code. Ensure your pull requests follow this style before submitting.

If you do decide to start coding please have a read of the other contributing documents:

Document Description
Scripts Lists the npm run scripts you can use to help develop your solution
Debugging Explains configuration for console debug messages using debug
Testing Explains the testing methods available
Ideas Features that could be added which are not being worked on

Main

How It Works

Contributing

API

Queue Methods

Queue Properties

Queue Events

Job Methods

Job Properties

Documentation

Clone this wiki locally