Difference between revisions of "ParaView/Guidelines for Contributing Plugins"

From KitwarePublic
Jump to: navigation, search
(Created page with "These guidelines are meant for anyone who wants to contribute their ParaView Plugins or Custom Applications to the community. # Ensure that your plugin can be built separately ...")
 
 
Line 9: Line 9:
 
## How to build the plugin (if different from the standard or if additional dependencies are present).
 
## How to build the plugin (if different from the standard or if additional dependencies are present).
 
## How to use the plugin.
 
## How to use the plugin.
# Add a link to this new page at [http://www.paraview.org/Wiki/index.php?title=ParaView&action=edit&section=18]
+
# Add a link to this new page on the [http://www.paraview.org/Wiki/index.php?title=ParaView&action=edit&section=18 index page].
  
 
If you want your plugin to be included in the official ParaView repository or binaries, please contact the developers using the mailing list (paraview@paraview.org).
 
If you want your plugin to be included in the official ParaView repository or binaries, please contact the developers using the mailing list (paraview@paraview.org).

Latest revision as of 08:42, 15 April 2011

These guidelines are meant for anyone who wants to contribute their ParaView Plugins or Custom Applications to the community.

  1. Ensure that your plugin can be built separately from a ParaView build.
  2. Post the plugin at a publicly accessible site. There are several open git repository hosting sites available e.g. www.gitorious.org, www.github.com . Create a repository to host your plugin at any such site.
  3. Add a Wiki page to this Wiki. Use "paraview.org/Wiki/ParaView/Plugins/<PluginName>" as the naming convention for creating this wiki page.
  4. The Wiki page should at the least include following information. A sample page is provided at ParaView/Plugins/ContributedPluginTemplate:
    1. What does the plugin provide/When to use the plugin?
    2. Location of the git repository and stable branch or tag. Ideally, you want to tag your plugin for every official release of ParaView, but that may not be necessary for most plugins.
    3. How to build the plugin (if different from the standard or if additional dependencies are present).
    4. How to use the plugin.
  5. Add a link to this new page on the index page.

If you want your plugin to be included in the official ParaView repository or binaries, please contact the developers using the mailing list (paraview@paraview.org).