POPFile Developer's Guide

Trace:

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
devel:developersguide [2008/02/09 18:09] – Links to tools changed to devel:tools1 mannidevel:developersguide [2013/08/26 11:45] (current) – external edit 127.0.0.1
Line 3: Line 3:
 ==== 1. How do I become a POPFile developer? ==== ==== 1. How do I become a POPFile developer? ====
  
-If you are interested in developing code for POPFile then you came to the +If you are interested in developing code for POPFile then you came to the right place.  The first thing you must do is read this document and understand it.
-right place.  The first thing you must do is read this document and +
-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 [[http://getpopfile.org/discussion/3| Bleeding Edge - Source Code forum]] on the POPFile website 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 we 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 we 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.
  
 You will also need to sign a POPFile License Agreement, see below. You will also need to sign a POPFile License Agreement, see below.
Line 15: Line 13:
 ==== 2. How do I post a patch? ==== ==== 2. How do I post a patch? ====
  
-First read this entire document, then create a patch using [[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 [[tools1| diff3]] (or a similar program) and post it to the [[http://getpopfile.org/query| Ticket Tracker]]. 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, [email protected].  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 owner, John Graham-Cumming, [email protected].  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 169: Line 167:
    therefore on which other developers can completely rely."     therefore on which other developers can completely rely." 
 </code> </code>
- 
 
devel/developersguide.txt · Last modified: 2013/08/26 11:45 by 127.0.0.1
Old revisions

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