This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
developersguide [2007/01/25 10:35] – manni | developersguide [2008/07/11 14:43] (current) – external edit 127.0.0.1 | ||
---|---|---|---|
Line 7: | Line 7: | ||
understand it. | understand it. | ||
- | Then go to the [[http://sourceforge.net/ | + | 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. |
It is important to realize that one thing I really care about in the code base is the quality of the code itself. | It is important to realize that one thing I really care about in the code base is the quality of the code itself. | ||
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 [[:tools | diff3]] (or a similar program) and post it to the [[http:// | + | 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 | + | Contact the project |
==== 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. | + | Each Perl module in POPFile should have a corresponding test file in the tests/ subdirectory. |
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 [[: | + | 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: |
A simple summary of this license is "you tell me that the code you wrote doesn' | A simple summary of this license is "you tell me that the code you wrote doesn' |
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.