Skip to content

Add plugin link and package.json advice #6128

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 1, 2025
Merged

Add plugin link and package.json advice #6128

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 10 additions & 5 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,9 +102,9 @@ You can learn about how to import markdown & partials
### Adding Plugins

To add a plugin, submit a [pull request](#Pull-Requests) with the corresponding
data added to the [`plugins.json`](/src/data/plugins.json) file. Your plugin
should have a name, description, link to the plugin's code, as well as any
keywords.
data added to the [`plugins.json`](/src/data/plugins.json) file.
Your plugin entry should have a name, description, link to the plugin's code (for example to a repository on GitHub),
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:
Expand All @@ -122,8 +122,13 @@ Each plugin submitted to the plugins list should have the following:
- Demonstrates the plugin working
- Acts as real-world example usage

2. CI pipeline
3. Compatibility with at least the latest major version of Cypress
1. CI pipeline
1. Compatibility with at least the latest major version of Cypress
1. Populated [package-json](https://docs.npmjs.com/cli/v11/configuring-npm/package-json) fields

- [homepage](https://docs.npmjs.com/cli/v11/configuring-npm/package-json#homepage)
- [repository](https://docs.npmjs.com/cli/v11/configuring-npm/package-json#repository) for the command [npm repo](https://docs.npmjs.com/cli/v11/commands/npm-repo)
- [bugs](https://docs.npmjs.com/cli/v11/configuring-npm/package-json#bugs) for the command [npm bugs](https://docs.npmjs.com/cli/v11/commands/npm-bugs)

Plugins are listed in the following order:

Expand Down