Skip to content

Development Workflow

felixwiemuth edited this page Nov 17, 2012 · 9 revisions

General Guidelines

  • Everyone has the right to change the master branch and release new versions.
  • The master branch should be stable at all times, experiment on your own branches (or repos).
  • Use the provided issue system.
  • These are just guidelines, do what you think is best.

Coding Standards

  • Set your IDE/editor to use 2 spaces for indenting, not tabs! Otherwise it'll be a mess.
  • When adding new features, try to build self-sufficient modules, loosely bound with the server, so that each module is more or less independent, hence replaceable and testable.

Workflow

Small changes (bugfixes)

  1. Test them
  2. Push to master branch
  3. Update zip file

New features, big changes

Including new commands, options, config files and behavior

  1. Post your plans as an issue
  2. Develop on a new branch
  3. Get feedback (if available), use "test" issues
  4. Carefully check if your changes interfere with other SimpleServer systems and further adjustments have to be made. Consider the Stability check section below.
  5. Merge into master branch
  6. Update the wiki reflecting your change or new feature (the documentation must not become outdated!)
  7. Delete old branch (it gets cluttered otherwise)
  8. Update zip file

Localization Development

see Localization Development Guidelines

Stability check

Some parts of SimpleServer have to be updated if special changes are made. This list should help to check if an update is needed.

Backup system

Occasion: The way backups are made is changed.

Todo:

  • Change the VERSION field in src/simpleserver/thread/AutoBackup.java
  • Update the archive structure in the wiki page

Release a new version

  1. Update version constant baseVersion in src/simpleserver/Main.java
  2. Clone Localization repository into the SimpleServer repository or make sure it is up-to-date
  3. Run ant release inside the SimpleServer repository
  4. Upload release/SimpleServer.zip and release/SimpleServer.jar

Clone this wiki locally