COMP 310 Fall 2014	Using Eclipse and Subclipse for Assignment Turn-In

To use Subversion ("SVN") source control for managing projects or for turn-in, be sure to first install the Subclipse plug-in. 

Follow the directions on the Subclipse web page to add the Comp310/510 repository to Subclipse and to learn how to work with the SVN repositories.

The Comp310 turn-in repository name is:

https://svn.rice.edu/r/comp310/turnin/F14/yourNetID

Clicking on the above link and adding your netID to the URL will take you to a web-view of your source-controlled code!

If you are unable to access your personal repository, let the staff know right away since the automatic procedure that creates the repository sometime misses registered students.   Only registered students will have repositories!

General Turn-in Procedure:

Turning in an assignment is nothing more than committing your work to the Comp310 repository:

1. NAME YOUR HOMEWORK PROPERLY!!   The name of the root folder for your homework assignment, i.e. the folder that holds the Exclipse .project file and the src and bin (classes) folders, should be "HWXX", e.g.  HW01, HW02, etc.   Failure to properly name your homework will result in points deductions!   

2. The following are ALWAYS required, failure to do so will result in up to -10% penalties:

   • All GUI components such as buttons, textfields, drop lists, text areas, etc. should have tool tips to help explain their purpose.

   • Full Javadoc-style comments (i.e. not "//" !) on all classes, methods and fields, including private ones.    The Javadocs should be generated and in a doc folder at the same level as the src folder.

   • UML diagram(s) that cover the entire codebase.   Multiple diagrams that help the reader see the system at different overview levels and highlight the various specific areas is encouraged  (note that the same class may appear in more than one diagram).   Overly large and messy diagrams will result in point deductions.

   • A README.txt file that gives clear directions on how to run your program, describing what options are available and what your program is doing.

3. Add your homework project, i.e. the HWXX folder, to the repository.   You may do this at any time.  It is HIGHLY recommended that you simply use the repository as part of your everyday development process.  

   • Add your code to the repository right when you start and keep updating it every 30 minutes or perhaps even more often than that!    You'll be glad you did because you'll never lose more than 1/2 hour's worth of work and you can roll-back your mistakes at any time too.

4. Before the due date, when you have completed your work, simply commit the entire project to the repository.

If you are modifying your work for the next assignment, be sure to copy all the files to a new project in your workspace and then separately add that project to the repository.   DO NOT OVERWRITE PREVIOUS ASSIGNMENT SUBMISSIONS!

Getting Help Is Easy

The staff can see your code in the repository at any time, so if you are having problems, simply commit your code and ask the staff to take a look at it. 

© 2014 by Stephen Wong