Contributing

Contributing documentation

The Wiki is generated from the stable master branch of OSPy-plugins. Do not edit generated plug-in pages as the authoritative source because the next generation replaces them.

Update a plug-in page

1. Update the plug-in's plugin.json name, version, description, compatibility, dependencies, hardware, permissions and interfaces.
2. Update its README.md with purpose, operation, configuration, safety behavior and relevant examples.
3. Update the shipped HTML help when users need the same explanation inside OSPy.
4. Run python tools/generate_plugin_table.py for the main README catalog.
5. Run python tools/generate_plugin_wiki.py C:\GitHub\OSPy-plugins.wiki to rebuild the Wiki checkout.
6. Run both generators with --check, the catalog/Wiki tests and git diff --check before committing.

The main repository README intentionally contains only project-wide information and the short generated catalog. Plug-in-specific release notes, setup details and diagrams belong in the plug-in README/help and therefore in this Wiki.

Back to the documentation home