-
Notifications
You must be signed in to change notification settings - Fork 37
rewrite always use good folder names section #64
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
base: main
Are you sure you want to change the base?
Conversation
I was confused by what it was saying until reading it a few times. I rewrote it to state each thing more clearly and try to set it up so it said why you do something before saying what should be done. I also softened the wording so as to not imply that you do legally binding due diligence.
| Not only would we not accept it for using the prohibited term ‘plugin’, the plugin team would validate that the plugin owner **legally** represents FaceRange. | ||
| If the folder name of your plugin cannot exist on WordPress.org, it cannot collide with a plugin hosted in the directory. | ||
|
|
||
| The WordPress.org plugin directory does not allow plugin slugs containing the term `plugin`, so any folder name ending in `-plugin` cannot be registered there. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There are specific cases in which plugin could be allowed, so I'd rephrase this as
In most cases, the WordPress.org plugin directory does not allow plugin slugs containing the term plugin
|
|
||
| The WordPress.org plugin directory does not allow plugin slugs containing the term `plugin`, so any folder name ending in `-plugin` cannot be registered there. | ||
|
|
||
| As part of the directory submission process, it is validated that the plugin owner has the right to represent the company name used. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd join this phrase with the previous one, the documentation tends to be written down using paragraphs composed of several sentences instead of small phrases.
|
|
||
| If you’re making a plugin for your company, you can use a folder name like `companyname-function-plugin`. For example, if you work for FaceRange and you’re making a status plugin, you could name the folder `facerange-status-plugin`. | ||
|
|
||
| This approach affects only the plugin’s folder name and does not change the plugin name shown in the admin UI. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure if this clarification is needed. At this point a developer shall know that the name is taken from the plugin headers.
I was confused by what it was saying until reading it a few times. I rewrote it to state each thing more clearly and try to set it up so it said why you do something before saying what should be done.
I also softened the wording so as to not imply that you do legally binding due diligence.