General guidelines for development

This page describe the current guidelines for planning and documentation of the development in the JModelica.org project. The guidelines are devised as to grant well documented code and a traceable development processes.

Before going into the details of tools and processes, there are four basic rules to keep in mind - which we should all strive to follow:

  • Always work with one specific Trac ticket in mind
  • Always write clear and descriptive Subversion commit messages
  • Always refer to a Trac ticket in a commit message (e.g., #12)
  • Always make a comment of a Subversion commit in a Trac ticket (e.g., r23)
  • Always run the test suite before committing code

Guidelines for specific tools and procedures: