Help:How can I provide patches for SMW+

From SMW+ Semantic Enterprise Wiki

Jump to: navigation, search

How can I provide patches for SMW+

By: Benjamin

Developer

This article gives information on the procedure that is to be followed as one prepares and provides patches for SMW+.

Check out your Halo extension status

At first, make sure you checked out the latest SVN trunk of the Halo extension. For details about this, just look at How can I check out the latest SMW+ code

Style guide

Make sure you did not do changes to any MediaWiki or SMW code and also ensure that have read the Developer style guide and followed our code conventions. Please also have a look at the MediaWiki manual article about coding conventions.

Test your patch

Always remember to test your modified Halo extension with respect to functionality. Basically you need to take care of this:

Use E_STRICT in your php.ini to have unnecessary warnings and notices reported early.^[1]
When adding features, it's vital to verify that you didn't actually break existing functionality.^[1]

Documentation

Kindly make sure that you have written and supplied a user documentation (for the end user) and software documentation (technical documentation) as well as Doxygen conform templates^[2] in your files/changes.

Create the patch file

Finally, update your SVN repository again to make sure you have the most recent version of the Halo extension. If you have created and tested your patch, you can get a patch file for your modifications against this code base by using:

SVN diff

svn diff path/to/modified_file.php > patch.txt

or GNU patch
- see How to use GNU patch for detailed information.

Provide the patch file

You are now you done and you may email the patch file to the developer team or attach it to the corresponding bug report.Congratulations and thank you!

To help us commit your patch faster, please indicate which of the following criteria your patch already passes i.e:

follows coding style guide
adds code documentation
adds user documentation in the wiki
adds new test code
passes existing tests
adds entry to changelog file
fixes bug number: XXXX

Note:

Please keep in mind that we may not approve all proposed changes for integration into the public central Halo extension codebase. If you have any doubts about the suitability of your changes, kindly contact the developer team before you start coding.

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the article "GNU Free Documentation License".

add a comment

Facts about How can I provide patches for SMW+RDF feed

Content title	How can I provide patches for SMW+ +
For audience	Developer +
Has overview	This article gives information on the procedure that is to be followed as one prepares and provides patches for SMW+.
Position in subsection overview	0 +
Reviewed by	Benjamin +

[testing-0] 1.0 ^1.1 http://www.mediawiki.org/wiki/How_to_become_a_MediaWiki_hacker#Testing

[1] ttp://www.stack.nl/~dimitri/doxygen/docblocks.html

[1]

[2]