GuidelinesForContributors

1. summary Best practices to follow when contributing code to PMTK3

When you contribute code, please follow these guidelines

  * Please contribute demos and/or new functionality.

 * Follow the general Matlab programming style guidelines [http://yagtom.googlecode.com/svn/trunk/html/style.html here].

  * Follow the guidelines on writing demos [http://code.google.com/p/pmtk3/wiki/writingDemos here]. Then, when publishDemos() is called, it will  make nice web pages, such as those listed [http://code.google.com/p/pmtk3/wiki/Demos here], 

  * Use PMTKauthor, PMTKurl, PMTKdate tags so that your code is automatically detected by [http://pmtk3.googlecode.com/svn/trunk/localUtil/reports/generateAuthorReport.m  generateAuthorReport], which auto-generates [http://code.google.com/p/pmtk3/wiki/contributingAuthors this page]

  * Use the tags listed [http://matlabtools.googlecode.com/svn/trunk/metaTools/htmlTagString.m here] to tag any properties of your functions or demos. This will be used to annotate them when we auto-generate synposes such as [http://code.google.com/p/pmtk3/wiki/synopsisPages these] using [http://matlabtools.googlecode.com/svn/trunk/metaTools/generateSynopsisTable.m generateSynopsisTable].

  * Use the debugDemos.m command, which creates a list  [http://pmtk3.googlecode.com/svn/trunk/docs/debugReport.html like this], to make sure your demos keep working. 

  * See [http://code.google.com/p/pmtkdata/wiki/GuidelinesForContributors this page] for details on adding data sets. 

  * See [svnMimeTypes this page] for an important note regarding svn mime types.