Skip to content

Commit cdb2d4b

Browse files
committed
Add plugin link and package.json advice
1 parent 715512c commit cdb2d4b

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

CONTRIBUTING.md

+10-5
Original file line numberDiff line numberDiff line change
@@ -102,9 +102,9 @@ You can learn about how to import markdown & partials
102102
### Adding Plugins
103103

104104
To add a plugin, submit a [pull request](#Pull-Requests) with the corresponding
105-
data added to the [`plugins.json`](/src/data/plugins.json) file. Your plugin
106-
should have a name, description, link to the plugin's code, as well as any
107-
keywords.
105+
data added to the [`plugins.json`](/src/data/plugins.json) file.
106+
Your plugin entry should have a name, description, link to the plugin's code (for example to a repository on GitHub),
107+
as well as any keywords.
108108

109109
We want to showcase plugins that work and have a good developer experience. This
110110
means that a good plugin generally has:
@@ -122,8 +122,13 @@ Each plugin submitted to the plugins list should have the following:
122122
- Demonstrates the plugin working
123123
- Acts as real-world example usage
124124

125-
2. CI pipeline
126-
3. Compatibility with at least the latest major version of Cypress
125+
1. CI pipeline
126+
1. Compatibility with at least the latest major version of Cypress
127+
1. Populated [package-json](https://docs.npmjs.com/cli/v11/configuring-npm/package-json) fields
128+
129+
- [homepage](https://docs.npmjs.com/cli/v11/configuring-npm/package-json#homepage)
130+
- [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)
131+
- [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)
127132

128133
Plugins are listed in the following order:
129134

0 commit comments

Comments
 (0)