wiki:DevelopersGuide/SVN_Account

How to get an JOSM SVN account

There are two different types of SVN accounts

  • JOSM core account - You only get an account for JOSM core after you supplied useful patches for some time using the bug tracker. There is no need to ask for it, the current maintainer will ask you.
  • OSM account - This account is needed to change plugins. This is the same account as for all the other OSM projects. See also here.

Rules for JOSM account

  • No edit wars.
  • Larger changes (or changes which very likely break the code) should be discussed at mailinglist or in a ticket first.
  • No changes in code without a reason. Don't change anything only to have it look nicer (i.e. adding setters/getters). There should always be benefit for the compiled software even if it is a long-term-goal.
  • Do code as it is already done elsewhere in code except you have good reason not to do so.
  • Don't introduce larger changes in the stabilization phase before a release.
  • JOSM SVN uses https for checkins. Easiest usage is to checkout JOSM directory in OSM SVN and change the link for core from http to https.

Some general rules for SVN usage

  • Check your code before doing a checkin.
    • Are all changes useful?
    • No debug parts left?
    • All new files included?
  • When you have a different view, don't change code, but contact original author first.
  • Errors can be corrected, but never been undone (SVN keeps the history).
  • Reworking code needs tactfulness.
  • Don't take code changes personal - nobody owns parts of the code.
  • Reference bugs in commit messages and also add a comment what you did.
  • When applying patches add the patch author (but not the email - except maybe encrippled).

Some SVN specifics

  • JOSM svn supports commit comments.
    • When a #<num> is in the comment, then the change log will contain a link to the referenced bug.
    • When "closed #<num>", "close #<num>", "closes #<num>", "fix #<num>", "fixed #<num>", "fixes #<num>" or "applied #<num>" is used, then the referenced bug is closed.
    • When "addresses #<num>", "re #<num>", "references #<num>", "refs #<num>"or "see #<num>" is used, then the commit comment is inserted in bug without closing it.
  • OSM SVN has same feature but addresses OSM bug tracker.
    • Don't use #<num> form in OSM (e.g. when fixing plugins) to address JOSM bug numbers, use #josm<num> instead.
  • It can be annoying to deal with Windows line endings on Linux and Mac and vice versa. Subversion has a feature to handle this automatically and convert the line endings to the system default. However, it has to be activated for each file separately by setting the subversion property svn:eol-style=native.
    Adding the property by hand for each new file is inconvenient and often gets forgotten. Please edit your subversion configuration, so the property is added automatically to each new java file.

Back to Developers Guide

Last modified 14 months ago Last modified on 2016-01-29T23:33:28+01:00