ShrinkWrap | Development and Contribution

Prerequisites
ProductVersionRequired
JDK>= 1.7, 1.5Yes, for Compilation (1.5 for runtime); JAVA_HOME and JAVA5_HOME env variables needs to be set
Apache Maven>=2.2.0Yes
Gitie. 1.7.1.1
Eclipse IDE
m2eclipse0.10.0Recommended for Eclipse
IntelliJ IDEA

 

Check Out, Build, and Test

 

Perform Once
  • (Optional) Fork the GitHub ShrinkWrap repository into your own account
  • Clone the ShrinkWrap Git Repo from your remote repo
  • Change into the repo directory
    • $> cd shrinkwrap
  • Add a remote to the upstream
    • Committers
    • Read-only
      • $> git remote add upstream git://github.com/shrinkwrap/shrinkwrap.git

 

Perform During Development
  • Ensure your local repo is up-to-date with the upstream
    • $> git pull upstream master
  • Build and run tests, installing into the local M2 repository
    • $> mvn clean install 
  • Build and run tests, including the lengthier Stress Tests (required for release)
    • $> mvn clean install -Pstress
  • When about to work on an issue, perform all work in a new branch named after the associated JIRA
    • $> git branch SHRINKWRAP-XXX
      $> git checkout SHRINKWRAP-XXX
  • After done making changes, add any files to the staging area, and commit to the branch
    • $> git status
    • $> git add <files> -v 
    • $> git commit -m '[SHRINKWRAP-XXX] Commit message referencing JIRA issue'
  • Push the branch to your repository
    • $> git push origin SHRINKWRAP-XXX
  • Get the changes upstream
    • Committers
      • $> git remote add username userRepoLocation
        $> git fetch username
        $> git checkout -b SHRINKWRAP-XXX remotes/username/SHRINKWRAP-XXX
        $> mvn clean install
        $> git checkout master
        $> git merge SHRINKWRAP-XXX
        $> mvn clean install
        $> git push origin master
        $> git push upstream master
    • Anonymous
      • Make a "Pull Request" via GitHub interface

 

Code format