Changes between Version 3 and Version 4 of Developers/Good Practices


Ignore:
Timestamp:
2018-11-08T23:29:35+01:00 (23 months ago)
Author:
nicolasmartin
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • Developers/Good Practices

    v3 v4  
    3434== Be smart while working with ticket 
    3535 
     36{{{#!rbox warning 
     37__Be careful if you combine the 2 cases__ 
     38}}} 
    3639 
     40- If the commit is related to ticket(s), we highly suggest to add the commit message as a comment in related ticket(s).  
     41  To do so, you can use a word from this list `addresses re references refs see` followed by usual ticket links). \\ 
     42  ''Ex: write `see #1948` somewhere in the commit message to link with #1948'' 
    3743 
    38 == Usual commands sequence to follow for creating a development branch 
     44* If the commit is a fix for ticket(s), you can close them with the commit. 
     45  To do so, you can use one of the word in the list `close closed closes fix fixed fixes` followed by usual ticket link(s). \\ 
     46  ''Ex: write `fix #1948` somewhere in the commit message to close #1948 without a browser.'' 
     47 
     48== Usual commands for major steps of a development branch 
    3949 
    4050{{{#!sh 
    41 #---------------------------------------------------------------------------------- 
    42 ## To repeat for each development branch 
    43 #---------------------------------------------------------------------------------- 
     51## Create your development branch locally 
     52##+ Here it is assumed that you have set up the recommended development environment  
     53$ svn copy trunk[@${REV}] branches/$year/dev_r${REV}_${NameOfNewBranch} 
     54##+ If not, create the dev branch directly in the repository then download it 
     55## $ svn copy     svn+ssh://${ID}@forge.ipsl.jussieu.fr/ipsl/forge/projets/nemo/svn/NEMO/trunk                \ 
     56##                svn+ssh://${ID}@forge.ipsl.jussieu.fr/ipsl/forge/projets/nemo/svn/NEMO/trunk/branches/$year/dev_r${REV}_${NameOfNewBranch} 
     57## $ svn checkout svn+ssh://${ID}@forge.ipsl.jussieu.fr/ipsl/forge/projets/nemo/svn/NEMO/trunk/branches/$year/dev_r${REV}_${NameOfNewBranch} 
    4458 
    45 ## Create your development branch locally 
    46 $ svn copy trunk[@${REV}]    branches/$year/'dev_r'${REV}_${NameOfNewBranch} 
    47  
    48 ## Edit the external references for your branch (${SVN_EDITOR} env. variable must be set) 
     59## If needed, edit the external references for your branch (${SVN_EDITOR} env. variable must be set) 
    4960$ svn propedit svn:externals ${PATH_BRANCH} 
    5061 
    51 ## If needed, push it to the repository (externals are versioned SVN properties) 
     62[...] 
     63 
     64## At your convenience, push your changes to the repository (externals are versioned SVN properties) 
    5265$ svn commit [-m 'log message'] ${PATH_BRANCH} 
    5366 
    54 $ cd ${PATH_BRANCH} 
     67[...] 
    5568 
    5669## Download sette tool to validate your changes to the NEMO reference 
    57 $ svn checkout http://forge.ipsl.jussieu.fr/nemo/svn/utils/CI/sette 
     70$ svn checkout http://forge.ipsl.jussieu.fr/nemo/svn/utils/CI/sette ${PATH_BRANCH} 
    5871 
    59 ## Doc figures for building NEMO manual (not mandatory) 
    60 $ svn checkout http://forge.ipsl.jussieu.fr/nemo/svn/utils/figures  doc/figures 
     72## Get documentation figures for building NEMO manual (not mandatory) 
     73$ svn checkout http://forge.ipsl.jussieu.fr/nemo/svn/utils/figures  ${PATH_BRANCH}/doc/figures 
    6174}}} 
    6275