Changes between Version 2 and Version 3 of DeveloperGuide


Ignore:
Timestamp:
Jan 2, 2010, 2:13:29 AM (15 years ago)
Author:
Gabriele Pohl
Comment:

Added backlink to index and build subsections

Legend:

Unmodified
Added
Removed
Modified

  • DeveloperGuide

    v2 v3  
    1 == Some general guidelines for new smartmontools developers ==
     1{{{
     2#!div style="border: 1pt solid; float:right; background-color: #E6E6FA; padding:10px; margin-right:30px; margin-top:20px"
     3{{{
     4#!html
     5<a href="TocDeveloper"><img width="40px" height="40px" src="http://smartmontools.sourceforge.net/pics/toc.gif"></a>
     6}}}
     7}}}
     8
     9= Some general guidelines for new smartmontools developers =
     10
     11[[PageOutline(3,Table of Contents, inline)]]
     12
     13=== Documentation ===
    214
    315 * Keep the documentation current, by updating these files:
    … …  
    719 * Add your name to the AUTHORS file
    820 * Update the CHANGELOG file (at the top) each time that you check in changes to SVN
    9  * Subscribe to the [https://lists.sourceforge.net/lists/listinfo/smartmontools-devel smartmontools developers mailing list]
     21
     22=== Code ===
     23
     24 * If you are adding substantial code or new code, add yourself as a copyright holder to the top of the relevant file(s).
     25 * Please [wiki:CodingStyle comment your code enough] to make it understandable to others.
     26 * Please keep in mind that smartmontools runs on many different platforms, so one should avoid platform and operating-system-specific code whenever possible. If you are concerned about the portability of your code, please write to the developers list to ask for help.
     27
     28=== Collaboration ===
     29
     30 * Subscribe to the [https://lists.sourceforge.net/lists/listinfo/smartmontools-devel smartmontools developers mailing list]
    1031 * Your code should in general be checked directly into SVN. If you are concerned that your changes might have a broad impact, then it is a good idea to circulate an email about it to the developers mailing list above, and perhaps to also circulate your changes in the form of a patch.
    11  * If you are adding substantial code or new code, add yourself as a copyright holder to the top of the relevant file(s).
    12  * Please comment your code enough to make it understandable to others.
    13  * Please keep in mind that smartmontools runs on many different platforms, so one should avoid platform and operating-system-specific code whenever possible.  If you are concerned about the portability of your code, please write to the developers list to ask for help.