GithubHelp home page GithubHelp logo

andreymatin / wp-brief Goto Github PK

View Code? Open in Web Editor NEW
0.0 0.0 0.0 279 KB

Brief is a WordPress plugin to show dashboard widget with development reports, readme, documentation from developer to client

License: GNU General Public License v2.0

JavaScript 93.39% PHP 6.61%
changelog discussions documentation php plugin reports wordpress wordpress-plugin

wp-brief's People

Contributors

andreymatin avatar

Watchers

 avatar  avatar

wp-brief's Issues

feedback #2: Rename functions and defines

You need to rename your functions and defines

wp-brief-main/brief.php:24:define('WPB_VERSION', '1.0.0');
wp-brief-main/brief.php:41: function wpb_settings($links)
wp-brief-main/includes/brief-settings.php:4:function wpb_options_menu_link()
wp-brief-main/includes/brief-settings.php:16:function wpb_options_content()

wpb_ is a bad prefix because wp is, generally, not a valid or safe prefix to use. Which means your prefix is b_ and that's way too short.

[WordPress Plugin Directory] Review in Progress: Brief

There are issues with your plugin code preventing it from being approved immediately. We have pended your submission in order to help you correct all issues so that it may be approved and published.

We ask you read this email in its entirety, address all listed issues, and reply to this email with your corrected code attached (or linked). You have 6 months to make all corrections, before your plugin will be rejected. Even so, as long as you reply to this email, we will be able to continue with your review and eventually publish your code.

Remember in addition to code quality, security and functionality, we require all plugins adhere to our guidelines. If you have not yet, please read them:

https://developer.wordpress.org/plugins/wordpress-org/detailed-plugin-guidelines/

We know it can be long, but you must follow the directions at the end as not doing so will result in your review being delayed. It is required for you to read and reply to these emails, and failure to do so will result in significant delays with your plugin being accepted.

Finally, should you at any time wish to alter your permalink (aka the plugin slug), you must explicitly tell us what you want it to be. Just changing the display name is not sufficient, and we require to you clearly state your desired permalink. Remember, permalinks cannot be altered after approval.

Be aware that you will not be able to submit another plugin while this one is being reviewed.

Tested Up To Value is Out of Date, Invalid, or Missing

The tested up to value in your plugin is not set to the current version of WordPress. This means your plugin will not show up in searches, as we require plugins to be compatible and documented as tested up to the most recent version of WordPress.

Please update your readme to show that it is tested up to the most recent version of WordPress. You cannot set it beyond the current version, as that will similarly cause your plugin not to be available on searches.

Example(s) from your plugin:

brief/readme.txt:5:Tested up to: 3.4

Incorrect Stable Tag

In your readme, your 'Stable Tag' does not match the Plugin Version as indicated in your main plugin file.

Readme:

brief/readme.txt:6:Stable tag: 4.3

Plugin File:

brief/brief.php:12: * Version: 1.0.0

Those need to be the same, or else your plugin will not download properly from WordPress.org

Please note: While currently using the stable tag of trunk currently works in the Plugin Directory, it's not actually a supported or recommended method to indicate new versions and may cause issues with automatic updates.

In the future, support for this may be removed. We ask you please properly use tags and increment them when you release new versions of your plugin, just like you update the plugin version in the main file. Having them match is the best way to be fully forward supporting.

Calling file locations poorly

The way your plugin is referencing other files is not going to work with all setups of WordPress.

When you hardcode in paths like wp-content or your plugin folder name, or assume that everyone has WordPress in the root of their domain, you cause anyone using 'Giving WordPress it's own directory' (a VERY common setup) to break. In addition, WordPress allows users to change the name of wp-content, so you would break anyone who chooses to do so.

Please review the following link and update your plugin accordingly. And don't worry about supporting WordPress 2.x or lower. We don't encourage it nor expect you to do so, so save yourself some time and energy.

Remember to make use of the FILE variable, in order than your plugin function properly in the real world.

Example(s) from your plugin:

brief/includes/brief-scripts.php:9: wp_enqueue_style('wpb-admin-style', plugins_url() . '/brief/assets/css/styles-admin.css');
brief/includes/brief-scripts.php:12: wp_enqueue_script('wpb-showdown', plugins_url() . '/brief/assets/js/showdown.js');
brief/includes/brief-scripts.php:15: wp_enqueue_script('wpb-main-script', plugins_url() . '/brief/assets/js/scripts-admin.js', 'jquery');


We believe this to be a complete review of all issues found in your plugin. If we have no response from this email address in 6 months, we will reject this submission in order to keep our queue manageable. To keep your review active, all we ask is that you make corrections and reply.

Your next steps are:

Make all the corrections related to the issues we listed.
Review your entire code to ensure there are no other related concerns.
Attach your corrected plugin as a zip file OR provide a link to a public location (Dropbox, Github, etc) from where we can download the code. A direct link to the zip is best.

Once we receive your updated code, we will re-review it from top down.

We again remind you that should you wish to alter your permalink (aka the plugin slug), you must explicitly tell us what you want it to be. We require to you clearly state in the body of your email what your desired permalink is. Permalinks cannot be altered after approval, and we generally do not accept requests to rename should you fail to inform us during the review.

Be aware that if your zip contains javascript files, you may not be able to email it as many hosts block that in the interests of security. Also note that all version control directories (like Github) will auto-generate a zip for you.

While we have tried to make this review as exhaustive as possible we, like you, are humans and may have missed things. As such, we will re-review the entire plugin when you send it back to us. We appreciate your patience and understanding.

If you have questions, concerns, or need clarification, please reply to this email and just ask us.

Note! If you asked for a permalink change and got a reply that is has been processed, remember that these emails will still use the original display name. Don't panic. If you did not get a reply that we processed the permalink, let us know immediately.

--
WordPress Plugin Review Team | [email protected]
https://make.wordpress.org/plugins/
https://developer.wordpress.org/plugins/wordpress-org/detailed-plugin-guidelines/

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.