Changes between Version 14 and Version 15 of Documentation/UserGuide/CommitOnTrunk


Ignore:
Timestamp:
2020-02-28T10:39:46+01:00 (4 years ago)
Author:
bguenet
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • Documentation/UserGuide/CommitOnTrunk

    v14 v15  
    11[[PageOutline]]  
    2 = Commit on the trunk or a branch = 
     2= Guidelines and help to commit on the trunk (or a branch) = 
     3Author: B. Guenet[[BR]] 
     4Last revision: 2020/02/28, B. Guenet 
     5 
    36Here are some general guidelines for committing into the trunk ORCHIDEE. These recommendations can also be applied to branches and other versions under SVN control.  
    47 
    58Before commit: 
    6  * the code must be conform to the ORCHIDEE coding guidelines  
    7  * update to latest version: the modifications must be integrated in the latest version of the trunk (use "svn update", or extract a new ORCHIDEE) 
    8  * the modifications must be tested on at least one platform using MPI parallelism (except if only comments are changed) 
    9  * check difference in results. The reason for a change in result must be known before the commit. If possible, avoid change in results.  
     9 * the code must be conform to the ORCHIDEE coding guidelines (Documentation/UserGuide/CodingGuidelines) 
     10 * update to latest version: the modifications must be integrated in the latest version of the trunk (use "svn update", or extract a new ORCHIDEE). Be sure that your original code is backup somewhere locally to avoid deleting developments during the update.  
     11 * if svn update induce some conflicts between your local version and the trunk version carefully check them and solve them manually if necessary. Don't forget then, once the conflicts are resolved, to do "svn resolved myfile.f90" 
     12 * the modifications must be tested on at least one platform using MPI parallelism (except if only comments are changed). This means that you should launch a test simulation on more than one processor. 
     13 * check difference in results from your history files. The reason for a change in result must be known before the commit. If possible, avoid change in results except if it was on purpose.  
    1014 * 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. 
    1115 
    … …  
    1317 * if the behaviour of the model change. For example: change in parameter name in getin function, change in default value for some parameters, etc.. 
    1418 * if the interface towards the atmosphere is changed 
    15  * big modifications 
     19 * structural modifications 
    1620 
    1721During commit: 
    1822 * a commit should only resolve one problem at a time, related to one ticket. 
    1923 * write a useful log message in English 
    20  * 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) 
     24 * Within this log message, 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) 
    2125 
    2226After commit: