Skip to content
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.

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

added new plugins in the list #6126

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

kabirfaisal1
Copy link

I added a new plug that I created in to the plugins.js

Copy link

netlify bot commented Mar 25, 2025

👷 Deploy request for cypress-docs pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit 9b05db3

@CLAassistant
Copy link

CLAassistant commented Mar 25, 2025

CLA assistant check
All committers have signed the CLA.

@cypress-app-bot
Copy link
Collaborator

@MikeMcC399
Copy link
Contributor

@kabirfaisal1

Regarding your submission for the plugin cypress-xporter, please review the requirements listed under Adding Plugins:

  • Integration tests with Cypress
  • CI pipeline
  • Compatibility with at least the latest major version of Cypress

In addition you should ensure that your package.json includes the key repository so that it is possible for users to report issues. Executing the following should be successful and not result in an error message:

$ npm repo cypress-xporter
npm error no repository

The link to your source code repository is also the one needed in the plugins list link key. If you look at the other entries in src/data/plugins.json you will see that they are mostly https://github.com/ URLs.

It would also be clearer for the git history if you change the title of this PR to include the name of your plugin cypress-xporter.

cc: @dingraham

MikeMcC399

This comment was marked as resolved.

@MikeMcC399
Copy link
Contributor

I suggest also to add the bugs field to your package-json.

Currently if you execute

npm bugs cypress-xporter

it opens only https://www.npmjs.com/package/cypress-xporter and there is no way there to enter any bug report.

@kabirfaisal1 kabirfaisal1 requested a review from MikeMcC399 March 25, 2025 13:05
Copy link
Contributor

@MikeMcC399 MikeMcC399 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You have asked for review again. There are still open points in the comments above.

I suggest that you set bugs to

https://github.com/kabirfaisal1/cypress-reporter/issues

Take a look at other plugins to see how they have set up their package.json

@kabirfaisal1
Copy link
Author

You have asked for review again. There are still open points in the comments above.

I suggest that you set bugs to

https://github.com/kabirfaisal1/cypress-reporter/issues

Take a look at other plugins to see how they have set up their package.json

Hi @MikeMcC399
updated done.
package/cypress-xporter
image

project Root:
image

@MikeMcC399
Copy link
Contributor

I suggest you add also the package-json fields

If you compare your plugin to others, you will see that this is common practice.

Currently there is no repository shown on https://www.npmjs.com/package/cypress-xporter

image

As mentioned above, I don't see the following points addressed at the moment:

  • Integration tests with Cypress
  • CI pipeline
  • Compatibility with at least the latest major version of Cypress (currently Cypress 14.x)

@MikeMcC399
Copy link
Contributor

Here is an example from https://github.com/cypress-io/github-action/blob/master/package.json

  "repository": {
    "type": "git",
    "url": "git+https://github.com/cypress-io/github-action.git"
  },
  "keywords": [
    "actions",
    "cypress-io"
  ],
  "author": "Cypress-io",
  "license": "MIT",
  "bugs": {
    "url": "https://github.com/cypress-io/github-action/issues"
  },
  "homepage": "https://github.com/cypress-io/github-action#readme",

@MikeMcC399
Copy link
Contributor

@kabirfaisal1

The requirements in https://github.com/cypress-io/cypress-documentation/blob/main/CONTRIBUTING.md#adding-plugins have been updated to include the package.json fields, so that this is clearer for you and other plugin submitters.

Please let us know if you intend to address the outstanding comments.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants