Changes between Version 20 and Version 21 of doc/tec/developerrules

Timestamp:

Feb 1, 2018 12:17:09 PM (7 years ago)

Author:

kanani

Comment:

--

doc/tec/developerrules

@@ -1 +1 @@
 = How to change and commit the source code and how to document modifications =
-[[NoteBox(note,Please note that the change-and-commit procedure has changed with revision r2235)]]
-
-Strict rules apply to formatting of the PALM FORTRAN code. These rules are outlined in the [attachment:PALM_coding_standard.docx PALM coding standard document].
 
 Only authorized users are allowed to commit changes to the repository.
 
-   1. Change source code in your current working copy. Document all changes in the respective file headers under "{{{Current revisions:}}}". Additionally, all changes might be documented in a local file (e.g. {{{~/palm/current_version/CURRENT_MODIFICATIONS}}}), including the names of those 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, until it works sufficiently. Starting with revision r2347 the script {{{testsuite}}} is available which can be used to test the current state of the trunk. Starting with r2515 the script {{{palmtest}}} supersedes {{{testsuite}}}. [[BR]] [[BR]]
-   3. Run the script document_changes to save the change comments ('''NOT''' for [attachment:howto_svn_branches.pdf branches]). After having made your changes in the source code, simply call
+'''1. Make sure your code complies to the [attachment:PALM_coding_standard.docx PALM coding standard].''' Strict rules apply to formatting of the PALM FORTRAN code.  [[BR]] [[BR]]
+'''2. Change source code in your current working copy and document all changes in the respective file headers''' under "{{{Current revisions:}}}". Additionally, all changes might be documented in a local file (e.g. {{{~/palm/current_version/CURRENT_MODIFICATIONS}}}), including the names of those 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]]
+'''3. Test the changed version, until it works sufficiently.''' Starting with r2515 the script {{{palmtest}}} is available which can be used to test the current state of the trunk ([wiki:doc/tec/testsuite details] about palmtest). [[BR]] [[BR]]
+'''4. Run the script document_changes to save the change comments''' ('''NOT''' for [attachment:howto_svn_branches.pdf branches]). After having made your changes in the source code, simply call
       {{{
          document_changes trunk
@@ -48 +46 @@
 
 
-   4. Commit the changes to the repository
+'''5. Commit the changes to the repository'''
       {{{
          svn commit -m "message string" trunk
@@ -59 +57 @@
       The id tag in the modified source code will change accordingly.
 
-   5. Enter the changes into the change log ([wiki:/doc/tec/changelog]). [[BR]] [[BR]]
+'''6. Enter the changes into the change log''' ([wiki:/doc/tec/changelog]). [[BR]] [[BR]]
 
 = How to work with svn branches =