Mailfilter - Development

Mailfilter Development

Mailfilter has been written from scratch by Andreas Bauer and is now maintained by the Mailfilter development team. If you have good ideas on how to improve the program, or want to join our team, then this is the right place to start. But please read on, before you actually submit any code.

How to Submit Code:

Step 1: Get the Code

Mailfilter's code and web pages are kept in an online SVN repository at SourceForge. Hence, all changes you may want to submit should be made against the respective working copy of that repository. Check-out is possible with the following instruction set. When prompted for a password, simply press the enter-key.

svn co https://mailfilter.svn.sourceforge.net/svnroot/mailfilter mailfilter

Step 2: Please respect our Coding Standard

Format your code such that no line is longer than 80 characters.
Source code should always be printable (although versions < 0.7 do not obey to this restriction either).
Most of Mailfilter's code is C++, parts are pure C. Try to use C++ as well, e.g. avoid C-style comments "/* ... */" in favour of "// ... ".
Variable names are "file_pointer", rather than "filePointer".
Pointers are "char* pt", rather than "char *pt".
Function calls are "function_call ()", rather than "function_call()", i.e. notice the space.

Indentation:

// Always indent like this:
if (...)
  {
    function ();
  }
else
  {
    another_function ();
  }

// Please do NOT indent like this:
if (...) {
  function ();
}
else {
  another_function ();
}

Step 3: Submit the Patch

A patch should always be made against the online SVN repository, i.e., rather than simply using diff, you should always use svn diff. This is necessary for us to be able to apply patches more easily. Please submit all your changes electronically to mailfilter-dev@lists.sourceforge.net, and don't forget to alter the ChangeLog.

Skripts and Add-Ons:

If you have created a nifty shell skript, or any other sort of Mailfilter add-on, then please let us know. We have a contrib directory, where we ship user supplied programs. Note, however, that any submission must be made under the terms of the GNU General Public License. Please, always include a copyright notice and a "readme" file to reflect that, otherwise we are not able to regard and distribute your work.