Permalink
Browse files

add docs how to contribute plugins [ci skip]

  • Loading branch information...
1 parent 2c13f89 commit b8915c6b94b02fe39e3425d316eaf5343b65eb1e @christian-bromann christian-bromann committed Oct 15, 2016
Showing with 29 additions and 0 deletions.
  1. +22 −0 CONTRIBUTING.md
  2. +7 −0 docs/guide/services/static-server.md
View
@@ -141,3 +141,25 @@ Here's a quick cheat-sheet:
When you have completed your updates to the documentation, push to your fork and submit a pull request.
+
+
+### Adding new framework, services or reporters
+
+If you've created a plugin for WebdriverIO please add your documentation to our docs section so we can deploy this to the website. There are three different types of plugins in WebdriverIO: framework adapters, services and reporters.
+
+If you published a new (well tested) framework adapter, please add some decent information about it to `/docs/guide/testrunner/frameworks.md`. It should explain how to write tests and what kind of options it supports (if not already documented in the actual framework).
+
+For reporters or services please create a new markdown file in `/docs/guide/(services|reporters)` that has the name of the plugin and contains the information of the project readme. The file should be introduced with a header section that looks like this:
+
+```
+name: <plugin-name>
+category: <services|reporter>
+tags: guide
+index: <a new index number>
+title: WebdriverIO - <plugin title>
+---
+```
+
+Make sure you apply a new index property to it so we can keep a sane ordering. Checkout other markdown pages for reporter or services to get a better idea of how this looks like.
+
+Last but not least make sure you've added the plugin to our cli configurator. For that open `/lib/cli.js` and add your plugin to the dedicated list of frameworks, reporters or services. Please apply the same structure as other plugins.
@@ -1,3 +1,10 @@
+name: selenium-standalone
+category: services
+tags: guide
+index: 7
+title: WebdriverIO - Selenium Standalone Service
+---
+
# Static Server Service
Some projects are front-end assets only and don't run on more than a static server. [This service](https://github.com/LeadPages/wdio-static-server-service) helps you to run a static file server during testing.

0 comments on commit b8915c6

Please sign in to comment.