Extension:BoilerPlate

The BoilerPlate extension is a blank extension template. It doesn't really do anything on its own, but provides boilerplate code for an actual MediaWiki extension. It also implements MediaWiki's preferred test automation and continuous integration (see that section below).

You should base your own code on the BoilerPlate extension, but for more in-depth comments and learning you should go and examine the extension.

Usage
To use it, enter the following commands to make a clean directory of just the BoilerPlate source code without the Git meta-data and other examples. (Substitute your extension's name for MyExtension.) Then in :


 * rename BoilerPlate files to MyExtension.
 * change  variable names, preserving case (i.e. boilerPlate -> myExtension).
 * replace  in   with your name.
 * run "git init" (if you are going to use git for version control)

Test automation and continuous integration
The BoilerPlate extension implements the standard entry points for test automation, running various code checkers for you that test for errors and enforce part of the MediaWiki coding conventions.

If your extension is hosted on gerrit.wikimedia.org, you can request that Wikimedia's continuous integration machinery run these tests on each commit; see 226680.

Installation
If you want to install this dummy extension on your wiki to see if it works or troubleshoot problems with your adaptation.

Earlier MediaWiki releases
If you want your extension to be compatible with earlier MediaWiki releases, consult the source code of release branches of the extension.