Version control

Back to Coding Standards

We use Subversion (SVN) to maintain the source code of OGDF. Basically, any up-to-date SVN client can be used to access the repository. When committing new or modified code, the following rules need to be followed:

• First update to the latest version of OGDF.
• Make sure that OGDF compiles on at least one of the reference systems (gcc 4.x, Visual C++ 8.x/9.x).
• If you have changed basic functionality of OGDF, perform sufficient tests to assure that OGDF is still functional; if required run the regression tests and assure that they finish successfully.
• If you work on some new functionality that is not used somewhere else, you only have to make sure that OGDF still compiles; but be aware that this code needs to be functional and carefully tested before it is released! However, if this code causes problems on other platforms these need to be fixed with high priority.
• If your commit causes a conflict, make sure that already committed code will not break; if necessary contact the other developer to resolve the conflict.
• Update the changelog!

Code that is committed to the repository needs to be reasonably structured and documented, in particular:

• Do not commit code that is a mess; other developers might want to read it. The repository is not the place to put try-and-error experiments!
• Committed code must comply with the coding standards.
• If you perform code modifications, adapt the documentation (doxygen documentation as well as other comments in the code) before committing the code.
• If you change the behavior of already documented functionality, directly adapt the documentation to avoid inconsistencies.
• Best practice is to add the doxygen documentation directly when writing the declaration of new classes, members etc.