minishift-addons
minishift-addons copied to clipboard
Add a add-on template for contributor
It would be good to have a ready add-on template where contributor will just fill his details quickly.
It will reduce review comments like you need install section etc etc IMO.
I am thinking as
= {Name} Add-on
# Few lines of description for add-on
== Prepare Minishift [Optional]
# Maybe your add-on need Minishift to be run with extra configurations
== Install add-on
# Steps to install add-on
== Apply {Name}
# Steps to apply your add-on
== Prerequisite steps for add-on [Optional]
# If your add-on required any steps to be performed before like Github integration etc.
== Remove {Name}
# Steps to remove your add-on
== Uninstall {Name} add-on [Optional]
# Steps to uninstall add-on
WDYT @minishift/minishift-dev ?
I think this would be incredibly useful to have in the repository (perhaps as a root level TEMPLATE.adoc file).
I would also recommend including templates for the commands to be run for installing, applying, removing, and uninstalling the add-on. These commands should be similar across the majority of add-ons.
@budhrg Thats a good idea.