| | 1 | == Some general guidelines for new smartmontools developers == |
| | 2 | |
| | 3 | * Keep the documentation current, by updating these files: |
| | 4 | * smartctl.8.in |
| | 5 | * smartd.8.in |
| | 6 | * smartd.conf.5.in |
| | 7 | * Add your name to the AUTHORS file |
| | 8 | * Update the CHANGELOG file (at the top) each time that you check in changes to CVS |
| | 9 | * Subscribe to the [https://lists.sourceforge.net/lists/listinfo/smartmontools-devel smartmontools developers mailing list] |
| | 10 | * Your code should in general be checked directly into CVS. 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. |
