README.md

You can contribute to the GuideChimp ecosystem and create your own plugins and extend GuideChimp functionality.

How To Start

• Fork GuideChimp repository
• Copy the plugins/_boilerplate folder and rename this (Notation: pluginName)
• Extend GuideChimp functionality
• Do not forget to test your plugin ☝️
• Provide installation and usage instructions in the plugin's README.md file
• Create Pull Request

We'll verify your submission and accept Pull Request if this will satisfy our quality requirements.

Plugin Template

We advise you to use plugins/_boilerplate/index.js as a starting point for the plugin development This template provides a reference for the most interesting events and methods, which can be extended/overridden. You can delete not needed code snippets as per your plugin requirements.

/**
 *
 * @param {Class} cls GuideChimp class
 * @param {Object} factory GuideChimp factory
 * @param {Array} args optional arguments needed for the plugin; for instance, the options object
 */
module.exports = (cls, factory, ...args) => {

    /**
     * extend GuideChimp() class
     * e.g. add GuideChimp(tour).customMethod()
     */
    cls.prototype.customMethod = () => {};
    
    /**
     * extend GuideChimp factory
     * e.g. add GuideChimp.customMethod()
     */
    factory.customMethod = () => {};

 
     // override existing API
     // e.g. extend GuideChimp().init()
     const parentInit = cls.prototype.init;
     cls.prototype.init = () => {
         parentInit();
 
         // custom code
         //...
     };

    // Override static method
    const parentDefaultOptions = cls.prototype.getDefaultOptions;
       cls.getDefaultOptions = () => ({
           ...parentDefaultOptions(),
           // custom options
           // ...
       });
 };