-
Notifications
You must be signed in to change notification settings - Fork 16
Contributing
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 |
- Introduction
- Tutorial
- Queue Constructor
- Queue Connection
- Queue Options
- Queue PubSub
- Queue Master
- Queue Events
- State Document
- Job Processing
- Job Options
- Job Status
- Job Retry
- Job Repeat
- Job Logging
- Job Editing
- Job Schema
- Job Name
- Complex Job
- Delayed Job
- Cancel Job
- Error Handling
- Queue.createJob
- Queue.addJob
- Queue.getJob
- Queue.findJob
- Queue.findJobByName
- Queue.containsJobByName
- Queue.cancelJob
- Queue.reanimateJob
- Queue.removeJob
- Queue.process
- Queue.review
- Queue.summary
- Queue.ready
- Queue.pause
- Queue.resume
- Queue.reset
- Queue.stop
- Queue.drop
- Queue.Job
- Queue.host
- Queue.port
- Queue.db
- Queue.name
- Queue.r
- Queue.id
- Queue.jobOptions [R/W]
- Queue.changeFeed
- Queue.master
- Queue.masterInterval
- Queue.removeFinishedJobs
- Queue.running
- Queue.concurrency [R/W]
- Queue.paused
- Queue.idle
- Event.ready
- Event.added
- Event.updated
- Event.active
- Event.processing
- Event.progress
- Event.log
- Event.pausing
- Event.paused
- Event.resumed
- Event.completed
- Event.cancelled
- Event.failed
- Event.terminated
- Event.reanimated
- Event.removed
- Event.idle
- Event.reset
- Event.error
- Event.reviewed
- Event.detached
- Event.stopping
- Event.stopped
- Event.dropped
- Job.setName
- Job.setPriority
- Job.setTimeout
- Job.setDateEnable
- Job.setRetryMax
- Job.setRetryDelay
- Job.setRepeat
- Job.setRepeatDelay
- Job.updateProgress
- Job.update
- Job.getCleanCopy
- Job.addLog
- Job.getLastLog