FRC Team 1884 (The Griffins) - 2016 Robot Code

###Javadoc Rules### Before the class body, Javadoc comments MUST have:
• Description of the class
• @author (Firstname Lastname)
• @version (For every push, increment by 1)
• @since (Date the class was created in DD/MM/YYYY)

Example:

//Import Statements

/**
* (Class Description)
*
* @author Kaito Arai
* @Version 1
* @since 1/1/2016
*/
//Class body

Before a method body, Javadoc comments MUST have:
• Short one line description of the method
• Longer description of the method
• @param (If any, describe every method parameter)
• @return (Describe the return value)
• @exception/@throw (If any, describe every exception that may be thrown from this method)

Example:

/**
* (One line description)
* <p>
* (Longer description)
* <p>
* @param paramName paramDescription
* @return returnDescription
* @throw exceptionDescription
*/
//Method body

Before a field declaration, Javadoc comments MUST have:
• Short one line description of the field

Example:

/**
* (One line description)
*/
//Field Declaration

Order Of Tags:

1. @author (classes and interfaces only, required)
2. @version (classes and interfaces only, required.)
3. @param (methods and constructors only)
4. @return (methods only)
5. @exception (@throws is a synonym added in Javadoc 1.2)
6. @see
7. @since
8. @serial (or @serialField or @serialData)
9. @deprecated (see How and When To Deprecate APIs)

NOTE: It is only necessary to write a Javadoc comment if it is public, although you may want to write Javadoc comments for private classes/constructors/methods/fields.

###Updating The Master Repository Prerequisites

• A Github Account
• Github Desktop
• Eclipse (set up with WPILIBJ) (recommended)

Setup

1. Ask the programming team to add you to the 1884Programmers organization.
2. Go to the master repository and click "fork". This will create a copy of the repo that is linked to the master one.
3. Open up Eclipse, and press "Navigate => Show In => Repositories" in the menu bar.
4. In the Git Repositories view, press the button that says "git" on it and has a blue curved arrow pointing down. When you hover over it, it should say "Clone a Git Repository and add the clone to this view".
5. In the box that pops up, put the link to your fork in the box labeled "URI", and put you login information in "Authentication". Note: If you click "Store in Secure Store", then your login credentials will be stored for future use. If you do not click this, you will have to log in every time you want to commit code.
6. Go to the "Git Repositories" view, and expand the repository you just cloned. Right click on "Remotes", and select "Create Remote". Name it "upstream". In the next menu paste the url for the master 1884Programmers repository. When you expand "Remotes" you should now see "upstream". If you see any remote other than origin and upstream, remove it by right clicking on it an then selecting remove as it is not needed.
7. In Github Desktop, you want to click the "+" icon in the top left. Click "browse", and browse to where you put the local files of your github repository, then click "Add Repository". Note: The default location for the local files of the github repository is in a folder named "git" under your user folder.
8. Also in Github Desktop, click "+" again. Click "clone" in the top of the window, put in the link to the 1884Programmers version of the repository.

Committing Code to the Master Repository

1. Open up your fork of the repo in Github Desktop and sync it. Under the compare view, click on the dropdown menu with the arrow to the right of a repository name and select "upstream/[whatever branch you're editing]".
2. Click the button that says "Update from [selected branch]", which should make your local copy up to date with the one up in the cloud.
3. PROGRAM!!!
4. Go back into your fork in Github Desktop, and go into the changes view which can be accessed by clickin in "Changes" in the top of the window. Put your commit message in the box labeled "Summary" and click "Commit to [selected branch]". Click "Sync" to add your commits to your cloud fork.
5. Final Step: Click "Pull Request" and make sure you are pushing to the correct repository and branch. Go into GitHub and check the Master Repo for the pull request. If they are able to be merged, click merge on the pull request page and you are done. If you run into issues, go to Will so you don't further screw up your code.