News: We're looking for extra members and developers. May 22, 2012, 01:58:37 pm
Welcome, Guest. Please login or register. *

Development Guidelines
Pages: 1
  Send this topic  |  Print  

  Development Guidelines
Author Message
0 Members and 2 Guests are viewing this topic.
2playgames
OpenWar Project Founder
Administrator
Sr. Member
***
Offline Offline

Posts: 857


Busy busy busy busy busy


View Profile WWW
« on: November 30, 2007, 11:45:05 pm »

SVN
Since SVN is prone to get messy when not controlled correctly, I'm setting up some guidelines.

- If you want to commit a new project or package, ask me (from now on I will act as SVN admin). I will tell you where you can put it.
- Every developer will get his own directory in the repository, where he is free to do what he wants.
- For the official projects (Victory Engine, RPG game, etc.) maintain the trunk/tags/branches layout
- Don't commit generated files (.class files, javadoc pages, test reports, ...) and location-specific files (.project, build.properties, ...)
- For non-trivial commits (moving a file, creating a new directory, things that don't affect the content of files) include a descriptive comment
- Update before starting editing

Code conventions
To better allow multiple developers to work on the same code, a coding convention must be followed. This convention has been made in the form of a Checkstyle configuration file, which can be found on SVN at artifacts/conventions/sourcecode/checkstyle.xml. You can import this file into Eclipse-CS, an eclipse plugin which uses checkstyle to automatically check your code while you are developing.
In the same directory on SVN you will find eclipseformatter.xml and eclipsecleanup.xml. In the eclipse preferences you can import these files as Java formatter and cleanup respectively, after which you can use "Source->Clean Up" in your editor to automatically change your code to follow many of the conventions.
You will also see a file snippet.xml, which you can import in eclipse. Snippets are handy pieces of code (currently they include subheaders for seperating constructors, methods, fields and getters/setters) which you can drag into your code from the Snippets view in Eclipse.
« Last Edit: December 17, 2007, 08:31:40 pm by 2playgames » Logged




Darvin
OpenWar Staff
Staff
Sr. Member
**
Offline Offline

Posts: 506


The Concept and Design King


View Profile
« Reply #1 on: December 01, 2007, 12:01:23 am »

All very logical (especially the last one... I can see all hell breaking loose if someone gets in the habit of ignoring it).  I'll be sure to follow them all.
Logged
2playgames
OpenWar Project Founder
Administrator
Sr. Member
***
Offline Offline

Posts: 857


Busy busy busy busy busy


View Profile WWW
« Reply #2 on: December 16, 2007, 04:35:09 pm »

added an important bit about code conventions
Logged





Pages: 1
  Send this topic  |  Print  
 

Jump to: