Changes between Initial Version and Version 1 of doc/tec/developerrules

Timestamp:

Sep 15, 2010 1:31:53 PM (15 years ago)

Author:

raasch

Comment:

--

doc/tec/developerrules

@@ +1 @@
+= How to change the source code and how to document modifications =
+
+Only authorized users are allowed to commit changes to the repository. Rules given below are still preliminary (Sep 2010) and may undergo future changes.
+
+   1. Change source code in your current working copy. Document changes in the respective file headers unter "{{{Current revisions:}}}". Additionally, document all changes in a local file (e.g. {{{~/palm/current_version/CURRENT_MODIFICATIONS}}}), including the files that have been changed. Classify changes in three cases, new (N), changed (C), and bugfix (B). Try to be as short and as precise as possible in describing the changes! [[BR]] [[BR]]
+   2. Test the changed version, unless it works sufficiently. [[BR]] [[BR]]
+   3. Commit the changes to the repository
+      {{{
+         svn commit -m "message string" trunk
+      }}}
+      where {{{"message string"}}} is a short, meaningful summary of the changes. [[BR]] [[BR]]
+      Alternatively, in case that you have made quite a lot of changes, you can also give the contents of your file {{{CURRENT_MODIFICATIONS}}} as the log message:
+      {{{
+         svn commit -F CURRENT_MODIFICATIONS trunk
+      }}} [[BR]] [[BR]]
+   4. Enter the changes into the change log ([wiki:doc/tec/changelog]). [[BR]] [[BR]]
+   5. Move the change comments in the file headers from {{{"Current revisions:"}}} to {{{"Former revisions:"}}}. Set the current svn id in front of that. [[BR]] [[BR]]
+      Example:  [[BR]] [[BR]]
+      before move:
+      {{{
+      ! Current revisions:
+      ! -----------------
+      ! new dummy argument abcd
+      !
+      ! Former revisions:
+      ! -----------------
+      ! $Id: init_3d_model.f90 425 2010-02-06 13:37:48Z raasch $
+      !
+      ! 407 2009-12-01 15:01:15Z maronga
+      ! var_ts is replaced by dots_max
+      }}} [[BR]] [[BR]]
+      after move:
+      {{{
+      ! Current revisions:
+      ! -----------------
+      !
+      !
+      ! Former revisions:
+      ! -----------------
+      ! $Id: init_3d_model.f90 425 2010-02-06 13:37:48Z raasch $
+      !
+      ! 425 2010-02-06 13:37:48Z raasch
+      ! new dummy argument abcd
+      !
+      ! 407 2009-12-01 15:01:15Z maronga
+      ! var_ts is replaced by dots_max
+      }}}  [[BR]] [[BR]]
+   6. Commit the changes in the technical documentation and the file headers:
+      {{{
+         svn commit -m "last commit documented" trunk
+      }}}