Add plugin link and package.json advice #6128
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
👷 Deploy request for cypress-docs pending review.Visit the deploys page to approve it
|
|
MikeMcC399
force-pushed
the
additional/plugin-prerequisites
branch
3 times, most recently
from
bc37b27 to
7d0348f
Compare
MikeMcC399
force-pushed
the
additional/plugin-prerequisites
branch
from
7d0348f to
71b5ae2
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Situation
The CONTRIBUTING > Adding Plugins section gives advice on how to submit to the src/data/plugins.json source file.
There are some gaps in this advice:
no explicit advice about what the target of the link field in the src/data/plugins.json should be
no requirement to provide a means to report issues for the plugin
Change
Add requirements to CONTRIBUTING > Adding Plugins:
link field
The link field in the src/data/plugins.json source file should contain a link to a source code repository, for example on GitHub
package.json fields
The following plugins' package-json fields should be populated: