New URL for NEMO forge!   http://forge.nemo-ocean.eu

Since March 2022 along with NEMO 4.2 release, the code development moved to a self-hosted GitLab.
This present forge is now archived and remained online for history.
Developers/GoodPractices (diff) – NEMO

Changes between Version 5 and Version 6 of Developers/GoodPractices


Ignore:
Timestamp:
2018-11-09T00:44:49+01:00 (5 years ago)
Author:
nicolasmartin
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Developers/GoodPractices

    v5 v6  
    11= Good Practices 
     2 
     3Last edition on '''[[Wikinfo(changed_ts)]]''' by '''[[Wikinfo(changed_by)]]''' 
    24 
    35[[PageOutline(2, , inline, unnumbered)]] 
     
    2426From that you have 2 options per external, either 
    2527- you want to be isolated by default from unwanted commits coming from outside, fix a revision for the definition (add `@` with revision number at the end of relative path) and you will be in safe mode. 
    26 - you want to be able to commit on this external from your dev branch, don't modify the definition but you will receive the commits at each SVN update. 
     28- you want to be able to commit on this external from your dev branch, don't set a revision on the definition but you will receive its commits at each SVN update. 
    2729 
    28 Of course you can change your mind any time and update the externals of your branch on a case-by-case basis. __But don't forget to push your modified externals to the repository__. 
     30Of course you can change your mind any time and update the externals of your branch on a case-by-case basis. __But don't forget to push your modified externals to the repository__.  
    2931 
     32Regarding the main branches for NEMO development, the default configuration for the externals will be as follows: '''releases with all externals fixed with revisions and trunk no revision set''' 
    3033 
    31 => configuration of NEMO releases 
    32 => current configuration of the trunk 
     34== Usual commands for major steps of a development branch 
     35 
     36[[Include(wiki:Developers/UsualCommands)]] 
    3337 
    3438== Be smart while working with ticket 
     
    3842}}} 
    3943 
    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'' 
     44If a commit is related to ticket(s), we highly suggest to add the commit message as a comment in related ticket(s).  
     45To do so, you can use a word from this list `addresses re references refs see` followed by usual ticket links). \\ 
     46''Ex: write `see #1948` somewhere in the commit message to link with #1948'' 
    4347 
    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 
    49  
    50 [[Include(wiki:Developers/UsualCommands)]] 
     48If a commit is a fix, you can close targeted ticket(s) with the commit. 
     49To do so, you can use one of the word in the list `close closed closes fix fixed fixes` followed by usual ticket link(s). \\ 
     50''Ex: write `fix #1948` somewhere in the commit message to close #1948 without a browser.''