Differences

This shows you the differences between two versions of the page.

developersguide [2008/02/09 19:09]
manni Links to tools changed to devel:tools1
developersguide [2008/07/11 14:43] (current)
amatubu update for new server
Line 7: Line 7:
understand it. understand it.
-Then go to the [[http://sourceforge.net/forum/forum.php?forum_id=230652| Bleeding Edge - Source Code forum]] on the POPFile page on SourceForge and post a message saying that you are interested in writing some code and making a suggestion.  You'll get honest feedback on the idea. This is very important because you don't want to waste your time coding something that someone else is working on.  It's also a good idea to find out whether I think your idea is good otherwise you might end up coding something that gets rejected, but most likely you'll get  encouragement and suggestions from other POPFile developers and a "show me" response from me.+Then go to the [[/discussion/3|Bleeding Edge - Source Code forum]] on the POPFile page and post a message saying that you are interested in writing some code and making a suggestion.  You'll get honest feedback on the idea. This is very important because you don't want to waste your time coding something that someone else is working on.  It's also a good idea to find out whether I think your idea is good otherwise you might end up coding something that gets rejected, but most likely you'll get  encouragement and suggestions from other POPFile developers and a "show me" response from me.
It is important to realize that one thing I really care about in the code base is the quality of the code itself.  That means taking the time to understand the POPFile coding style and how to write POPFile tests is very important.  Changes to POPFile that are untested or don't meet the coding style will be rejected. It is important to realize that one thing I really care about in the code base is the quality of the code itself.  That means taking the time to understand the POPFile coding style and how to write POPFile tests is very important.  Changes to POPFile that are untested or don't meet the coding style will be rejected.
Line 15: Line 15:
==== 2. How do I post a patch? ==== ==== 2. How do I post a patch? ====
-First read this entire document, then create a patch using [[devel:tools1| diff3]] (or a similar program) and post it to the [[http://sourceforge.net/tracker/?group_id=63137&atid=502958| Patches database]] on SourceForge. Make sure that your patch meets the coding standard and has associated unit tests (unless it's really, really, really simple).+First read this entire document, then create a patch using [[devel:tools1| diff3]] (or a similar program) and [[/newticket|create a new ticket]] and attach the patch. Make sure that your patch meets the coding standard and has associated unit tests (unless it's really, really, really simple).
-Before you post your patch it's a good idea if you run the POPFile test suite against your version of the code to make sure you didn't break anything else.  Posting a patch that meets the coding standard, has its own tests and passes the full POPFile test suite is the best way to get on my good side, get your code in CVS and one day maybe get CVS access for yourself.+Before you post your patch it's a good idea if you run the POPFile test suite against your version of the code to make sure you didn't break anything else.  Posting a patch that meets the coding standard, has its own tests and passes the full POPFile test suite is the best way to get on my good side, get your code in SVN and one day maybe get SVN access for yourself.
-==== 3. How do I get CVS commit access? ====+==== 3. How do I get SVN commit access? ====
-Contact the project owner, John Graham-Cumming, jgrahamc@users.sf.net.  You'll get CVS access if you consistently deliver great patches and come join in with the other developers in the [Bleeding Edge - Source Code] forum, follow the coding guidelines, write good tests and, even better, take direction from me on changes that I want to change in POPFile.+Contact the project Core Team member (Brian, Joseph, Manni and Naoki).  You'll get SVN access if you consistently deliver great patches and come join in with the other developers in the [Bleeding Edge - Source Code] forum, follow the coding guidelines, write good tests and, even better, take direction from me on changes that I want to change in POPFile.
==== 4. Does POPFile have a coding style? ==== ==== 4. Does POPFile have a coding style? ====
Line 117: Line 117:
tests.pl will run all the .tst files printing a . for each test that passes and an appropriate error for those that fail, and then print out a summary at the end of the total number of tests and the number that failed. tests.pl will run all the .tst files printing a . for each test that passes and an appropriate error for those that fail, and then print out a summary at the end of the total number of tests and the number that failed.
-Each Perl module in POPFile should have a corresponding test file in the tests/ subdirectory.  For example, for MailParse.pm we have TestMailParse.tst.+Each Perl module in POPFile should have a corresponding test file in the tests/ subdirectory.  For example, for %%MailParse.pm%% we have %%TestMailParse.tst%%.
Before checking in new code or submitting a patch run the test suite to protect against regressions. Before checking in new code or submitting a patch run the test suite to protect against regressions.
Line 123: Line 123:
==== 6. Why do I have to sign copyright over to John Graham-Cumming? ==== ==== 6. Why do I have to sign copyright over to John Graham-Cumming? ====
-POPFile is released under the General Public License used for free software but in order to ensure that the actual code is free of any claims by people who's interests are different from the GPL and to enable me to litigate cleanly if someone were to break the GPL and to create derivative versions of POPFile from code that is contributed without legal problems contributors are required to sign the [[:LicenseAgreement | POPFile License Agreement]].+POPFile is released under the General Public License used for free software but in order to ensure that the actual code is free of any claims by people who's interests are different from the GPL and to enable me to litigate cleanly if someone were to break the GPL and to create derivative versions of POPFile from code that is contributed without legal problems contributors are required to sign the [[devel:LicenseAgreement |POPFile License Agreement]].
A simple summary of this license is "you tell me that the code you wrote doesn't belong to someone else, you give me the right to do what I like with it in the context of POPFile, and I protect you from getting sued if your code in POPFile 'injures' someone". A simple summary of this license is "you tell me that the code you wrote doesn't belong to someone else, you give me the right to do what I like with it in the context of POPFile, and I protect you from getting sued if your code in POPFile 'injures' someone".
 
developersguide.txt · Last modified: 2008/07/11 14:43 by amatubu

Should you find anything in the documentation that is incomplete, unclear, outdated or just plain wrong, please let us know and leave a note in the Documentation Forum.

Recent changes RSS feed Donate Driven by DokuWiki
The content of this wiki is protected by the GNU Fee Documentation License