diff --git a/.github/ISSUE_TEMPLATE/add_plugin.md b/.github/ISSUE_TEMPLATE/add_plugin.md index 13d6bff6..bdf675e6 100644 --- a/.github/ISSUE_TEMPLATE/add_plugin.md +++ b/.github/ISSUE_TEMPLATE/add_plugin.md @@ -18,36 +18,33 @@ A brief description what your plugin does. Consider including screenshots to hel #### Review commit ## Checklist **Product requirements** - [ ] The plugin is published under an [Open Source license](https://opensource.org/licenses/alphabetical). -- [ ] The source code is available in a public git repository. +- [ ] The source code is available in a public Git repository. - [ ] There is a public issue or bug tracker for the plugin, which is linked in the plugin documentation and linked via `support_url` in the manifest. -- [ ] The plugin provides detailed usage documentation with at least one screenshot of the plugin in action, list of features, and a development guide. This is typically a `README` file or a landing page on the web. The link to the documentation is set as `homepage_url` in the manifest. A great example is the [`README` of the GitHub plugin](https://github.com/mattermost/mattermost-plugin-github/blob/master/README.md). - [ ] For the current release and upcoming ones a changelog has to be published, with a link recorded in the `release_notes_url` property of the `plugin.json` manifest. - [ ] The plugin has to be out of Beta and be released with at least v1.0.0. -- [ ] All configuration is accessible via the Mattermost UI. +- [ ] All configuration is accessible via the Mattermost interface. - [ ] The plugin ID defined in the manifest must not collide with the ID of an existing plugin in the Marketplace. It should follow [the documentation's suggested naming convention](https://developers.mattermost.com/extend/plugins/manifest-reference/#id). **Technical requirements** -- [ ] The plugin works for 60k concurrent connections and in a high-availability deployment. **Note:** There are currently no publicly-available tools to verify these properties. As such, they are checked during code review by a developer. +- [ ] The plugin works for 60k concurrent connections and in a High Availability deployment. **Note:** There are currently no publicly-available tools to verify these properties. As such, they are checked during code review by a developer. - [ ] The plugin logs important events on appropriate log levels to allow System Admins to troubleshoot issues. **Security requirements** @@ -59,3 +56,17 @@ If your plugin isn't production ready, please leave a comment stating whether yo - [ ] The plugin must set a `min_server_version` in the manifest. - [ ] The plugin must work on all Mattermost versions greater than or equal to the `min_server_version`. + +**Documentation requirements (checked by a Technical Writer)** + +- [ ] The plugin must include detailed usage documentation with at least one screenshot of the plugin in action, list of features, and a development guide. This is typically a `README` file or a landing page on the web. The link to the documentation is set as `homepage_url` in the manifest. A great example is the [`README` of the GitHub plugin](https://github.com/mattermost/mattermost-plugin-github/blob/master/README.md). Typical components of documentation include: + + * Requirements/Prerequisites + * Installation steps + * Configuration steps + * Usage + * Troubleshooting + * Screenshots (if available) + * Link or email address for help/support + +The `plugin.json` file should include formatting consistent with the System Console interface. You can join the [Documentation channel](https://community.mattermost.com/core/channels/documentation) for assistance.