To provide clarity on the requirements for a community plugin to be classified as Approved or Certified
In order to support our community, we want to show our appreciation to the plugin developers of the Serverless framework. One way to do that is to recognise specific plugins for the positive impact they have on the community as a whole. In addition, we would like to ensure that the broader community of developers using the Serverless Framework can confidently use specific plugins with the knowledge that the plugin will be maintained as needed into the future. It also means that we can directly support our clients on our enterprise support packages with plugins specifically confirmed to meet requirements that make it possible to provide this service.
In order to have a plugin considered for the various levels of support, the author make sure the criteria is met below and then complete the form at https://forms.gle/zYMGSSpRUjdiGe2R6. Someone at Serverless will review the application and inform the author of the result; whether any criteria still need to be met and whether the status of the plugin within the plugin repo has or will be updated.
A Community plugin has some basic documentation requirements for it to become recognised as such:
Usage Requirements - Provides details as to the minimum requirements in order to make use of the plugin and MAY include:
Installation Instructions - Provides instructions on how to install the plugin, and SHOULD include:
An Approved plugin must satisfy all the criteria of a Community plugin as well as additional requirements below.
For enterprise customers on a support SLA, approved plugins will receive the contracted SLA time or 24 hours, whichever is longer
An approved plugin MUST have clear, consistent documentation in the form of a Readme in the project repository. The following sections MUST be included in the documentation:
Feature Details - A reference section that describes each feature and its available options in detail:
At least one example of the plugin usage, which meets the following criteria, is required:
Basic tests must be in place, which meet the following criteria:
For enterprise customers on a support SLA, certified plugins will receive the contracted SLA time or 12 hours, whichever is longer.
In order for a plugin to become certified, it must satisfy all criteria for an Approved plugin plus the following requirements:
Continuous Integration/Continuous Delivery, meeting the following requirements, should be in place: