Skip to content

Developer's Guide

Jump to bottom
cpettitt edited this page Sep 22, 2012 · 11 revisions

Quick Start

  1. Download and install Java JDK 1.6. While it is possible to compile ParSeq with Java 1.7, we are currently performing release builds with 1.6.

  2. Install Apache Ant. We currently use version 1.8.2.

  3. Optionally install node.js and npm for trace visualization.

  4. Clone the ParSeq repository: git clone git://github.com/linkedin/parseq.git

  5. Use ant test to verify that the source code passes all unit tests. If you do not have node.js installed, you can skip the javascript tests with: ant -Dno.test.tracevis=1 test

  6. Use ant dist to build the ParSeq library into the dist directory.

Contributing

All contributions must be made under the Apache License, Version 2.0.

Committers

We're following a model that follows a subset of the github flow:

  1. Master should always be left in a state where a new release can be made.

  2. Create a descriptively named branch off of master.

  3. Work on your feature on this branch, periodically pushing to github.

  4. Verify that all tests pass.

  5. Open a pull request for your branch to get it reviewed.

  6. Once you get a 👍, :shipit:, or the like from another committer, change to master, use git merge --ff-only <feature-branch> and then push your changes to the github repo.

  7. Cleanup the github repo by removing the branch using git push :<feature-branch>

Non-Committers

Note: if you intend to make large changes, please let us know by filing an issue.

  1. Fork the ParSeq repository on github.

  2. Make changes in your fork.

  3. Verify all tests pass.

  4. Initiate a pull request.

  5. One of the ParSeq committers will review your request and either provide feedback or pull the commit into the master repository.

Resources

Clone this wiki locally