Developer Quickstart Guide

alexdean201 edited this page Jun 30, 2016 · 5 revisions

Follow these instructions the first time you set up your machine for Java development. The SmarterApp source was developed primarily using the following tools:

  • Spring Tool Suite (STS) IDE
  • Maven
  • Java 7
  • Tomcat / tcserver 7
  • GitHub
  • Artifactory

On your local machine

  1. Download and install the latest JDK.

  2. Download and install the latest Spring Tool Suite (STS).

    • You may need to adjust the STS.ini file by adding the following in order to launch the IDE:
      -vm
      <path to your JDK>
  3. If you do not already have a native git client and/or a git client ui installed on your machine, install one. Some choices are

  4. Install the latest version of Maven on your PC and point your STS to that installation (rather than using the embedded version of Maven). Maven installation and STS configuration instructions

On GitHub.com:

  1. Register as a new user, if you've not already done so.

  2. Contact one of the project admins to add you to the appropriate Developers group.

  3. Go to your Settings page (under your avatar), click on SSH and GPG Keys under Personal Settings, and click on New SSH Key. Follow the instructions to paste the contents of the ~/.ssh/id_rsa.pub public key file you created earlier into it, and save. Instructions are here.

On Artifactory

  1. Contact a project admin to add you as a user. If only exporting artifacts, and READ ONLY account is necessary. If posting artifacts, a READ/WRITE account is required.

Repository Branching

  1. Create a fork of the specific repository master branch for development

  2. Refresh your fork periodically from the master branch for any code updates

  3. When ready, create a pull request to merge your fork back to the master branch. Smarter Balanced admins will review the code and commit the changes to the master branch.

Software Version Numbering

Follow the semantic version numbering http://semver.org/. This scheme states that:

  1. The versions are MAJOR.MINOR.PATCH

  2. Increment MAJOR when there is a new feature that has breaking changes or incompatible API changes.

  3. Increment MINOR when a new feature is released that is backwards compatible

  4. Increment PATCH for bug fixes

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.