wiki:Documentation/UserGuide/CommitOnTrunk

Version 7 (modified by jgipsl, 7 years ago) (diff)

--

Commit on the trunk

Here are some general guidelines for committing into the trunk ORCHIDEE. These recommendations can also be applied to branches and other versions under SVN control.

Before commit:

  • the code must be conform to the ORCHIDEE coding guidelines
  • update to latest version: the modifications must be integrated in the latest version of the trunk (use "svn update", or extract a new ORCHIDEE)
  • the modifications must be tested on at least one platform using MPI parallelism (except if only comments are changed)
  • check difference in results. The reason for a change in result must be known before the commit. If possible, avoid change in results.
  • communicate and/or be aware of the latest news in the ORCHIDEE core team. For example a colleague announced that she/he will make a commit, better wait or ask if you could commit before.

Some cases must be discussed in advance:

  • if the behavior of the model change. For example: change in parameter name in getin function, change in default value for some parameters, etc..
  • if the interface towards the atmosphere is changed
  • big modifications

During commit:

  • one commit per ticket
  • write a useful log message in English
  • use #X to refer to the ticket number X (the # will make a link directly to the ticket when visualizing the log message on the web)

After commit:

  • for important changes, make a note here: trunk
  • tell the project group if the results changed even for tiny changes. A new reference must then be done in the trusting.
  • if related to a ticket, add a link to the commit in the ticket using [Y], where Y is the revision number on the commit. Close the ticket if all questions are treated.