Skip to content

Commit

Permalink
Merge pull request #3827 from cypress-io/fix/update-contributing-plug…
Browse files Browse the repository at this point in the history
…ins-criteria

docs: update plugins requirements in CONTRIBUTING.md
  • Loading branch information
matthamil authored Apr 12, 2021
2 parents dfd617a + f46daa9 commit 18b2fea
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,23 @@ Add an associated image with the example within the [`assets/img`](/assets/img)

To add a plugin, submit a [pull request](#Pull-Requests) with the corresponding data added to the [`plugins.json`](/content/_data/plugins.json) file. Your plugin should have a name, description, link to the plugin's code, as well as any keywords.

We want to showcase plugins that work and have a good developer experience. This means that a good plugin generally has:

1. Purpose of plugin articulated up front
1. Installation guide
1. Options and API are documented
1. Easy to follow documentation. Users should not have to read the source code to get things working.

Each plugin submitted to the plugins list should have the following:

1. Integration tests with Cypress

- Demonstrates the plugin working
- Acts as real-world example usage

2. CI pipeline
3. Compatability with at least the latest major version of Cypress

### Adding Pages

To add a page such as a new guide or API documentation:
Expand Down

0 comments on commit 18b2fea

Please sign in to comment.