Plugin source code and issue prerequisites

[MikeMcC399]

Description

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

Assessment

The npm registry https://www.npmjs.com/ displays a Code (Beta) tab. This satisfies the code requirement.

It also displays both a Repository field and a Homepage field. These are taken from the package-json fields:

• repository
• homepage

There is also a field

• bugs

These fields need to be populated to be effective.

Suggestion

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 https://github.com/cypress-io/eslint-plugin-cypress

package.json fields

The following plugins' package-json fields should be populated:

• bugs
• homepage
• repository

Executing the following commands, should work:

npm bugs
npm repo

for example:

Command	Browser opens in
npm repo eslint-plugin-cypress	https://github.com/cypress-io/eslint-plugin-cypress
npm bugs eslint-plugin-cypress	https://github.com/cypress-io/eslint-plugin-cypress/issues

[MikeMcC399]

I plan to submit a PR to propose this documentation change.