docs: rework contributor instructions

[MikeMcC399]

Details

The CONTRIBUTING document is reworked and expanded in detail.

Corrections

• The following step was added to the instructions. The fact that this was missing has led to rules being published inactive in the past. (See history of index.js listing multiple examples of this mistake over the years.)

  Add the rule to index.js

Additions

The following sections are added:

• Preparation
• Rule references
• New rule
• Document generation
• Legacy tests

Generally the level of detail has been increased.

Document generation

The utility ESLint eslint-doc-generator is introduced as an optional way to produce consistent documentation. It has already been used in:

• docs: rule readme harmonization #197
• docs: rule documentation harmonization #198

and so the README and documents in the docs/rules directory are prepared to use eslint-doc-generator.

• There is a Peer dependency warnings on ESLint v9 bmish/eslint-doc-generator#525 in the current version, so it has been recommended to install it globally to avoid the warning. When this issue is resolved, which may take some time due to complex interdependencies, it could be added directly into the repo.

Legacy tests

• The directory tests-legacy added in PR tests: save legacy tests #205 is explained.

[cypress-app-bot]

• Create a Draft Pull Request if your PR is not ready for review. Mark the PR as Ready for Review when you're ready for a Cypress team member to review the PR.

[MikeMcC399]

Preview

https://github.com/MikeMcC399/eslint-plugin-cypress/blob/docs/contributor/CONTRIBUTING.md

[jennifer-shehane]

This is great! Very straightforward

[MikeMcC399]

@jennifer-shehane

This is great! Very straightforward

Thanks! If there is any need for creating new rules, then rule authors should have a slightly easier time now!