WordPress / WordPress/plugin-check

Check: README Third parties MUST have privacy notes in the readme

Open
#475 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

  • #832 by @davidperezgar — closed without merging
[Team] Plugins Checks
Dominant language
PHP
Stars
362
Forks
126
Avg merge
1d 23h
Merged PRs (30d)
22

Description

In this check, we find third parties and ask the users to add it in the readme. So, we need to:

  • Detect external calls
  • Search in the readme to see that is added

And we make this reply to our users

Undocumented use of a 3rd Party or external service

 
We permit plugins to require the use of 3rd party (i.e. external) services, provided they are properly documented in a clear manner.

We require plugins that reach out to other services to disclose this, in clear and plain language, so users are aware of where data is being sent. This allows them to ensure that any legal issues with data transmissions are covered. This is true even if you are the 3rd party service.

In order to do so, you must update your readme to do the following:

clearly explain that your plugin is relying on a 3rd party as a service and under what circumstances
provide a link to the service
provide a link to the services’ a terms of use and/or privacy policies

Remember, this is for your own legal protection. Use of services must be upfront and well documented.

Example(s) from your plugin:

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files or tests are named. Start by reviewing the linked pull request #832 and the existing check entry points, then trace how external calls and README content are analyzed; done means the check detects undocumented third-party services and produces the specified guidance.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.