10% github-readme

Code Review | Github README

WordPress plugin Github README scored10%from 54 tests.

About plugin

  • Plugin page: github-readme
  • Plugin version: 0.2.0
  • PHP version: 7.4.16
  • WordPress compatibility: 3.0.1-4.5.2
  • WordPress version: 6.3.1
  • First release: Jan 1, 2015
  • Latest release: Jun 7, 2016
  • Number of updates: 10
  • Update frequency: every 52.4 days
  • Top authors: octalmage (100%)

Code review

54 tests

User reviews

4 reviews

Install metrics

70+ active /2,526 total downloads

Benchmarks

Plugin footprint 40% from 16 tests

Installer 0% from 1 test

🔺 Critical test (weight: 50) | The install procedure must perform silently
You still need to fix the following installer errors
  • The plugin did not install without errors
    • > Deprecated in wp-content/plugins/github-readme/Michelf/Markdown.php+800
    Array and string offset access syntax with curly braces is deprecated

Server metrics [RAM: ▼1.68MB] [CPU: ▼55.50ms] Passed 4 tests

An overview of server-side resources used by Github README
No issues were detected with server-side resource usage
PageMemory (MB)CPU Time (ms)
Home /2.30 ▼1.165.86 ▼40.59
Dashboard /wp-admin2.32 ▼0.987.13 ▼49.25
Posts /wp-admin/edit.php2.32 ▼1.036.56 ▼43.23
Add New Post /wp-admin/post-new.php2.32 ▼3.568.34 ▼88.94
Media Library /wp-admin/upload.php2.32 ▼0.905.96 ▼28.78

Server storage [IO: ▲0.10MB] [DB: ▲0.00MB] Passed 3 tests

How much does this plugin use your filesystem and database?
The plugin installed successfully
Filesystem: 8 new files
Database: no new tables, 6 new options
New WordPress options
widget_theysaidso_widget
theysaidso_admin_options
widget_recent-posts
can_compress_scripts
db_upgraded
widget_recent-comments

Browser metrics Passed 4 tests

Github README: an overview of browser usage
Normal browser usage
PageNodesMemory (MB)Script (ms)Layout (ms)
Home /2,814 ▲5314.37 ▲0.192.23 ▲0.1942.37 ▼3.61
Dashboard /wp-admin2,198 ▲215.61 ▲0.0489.29 ▼15.0341.22 ▼0.28
Posts /wp-admin/edit.php2,100 ▲31.99 ▼0.0034.38 ▼2.9637.41 ▲2.32
Add New Post /wp-admin/post-new.php1,528 ▼723.39 ▲5.35656.07 ▲14.7952.77 ▼11.62
Media Library /wp-admin/upload.php1,400 ▼34.20 ▼0.0198.69 ▼1.6144.27 ▲1.54

Uninstaller [IO: ▲0.00MB] [DB: ▲0.00MB] 50% from 4 tests

🔸 Tests weight: 35 | It is important to correctly uninstall your plugin, without leaving any traces
You still need to fix the following
  • The plugin did not uninstall gracefully
    • > Deprecated in wp-content/plugins/github-readme/Michelf/Markdown.php+800
    Array and string offset access syntax with curly braces is deprecated
  • The uninstall procedure has failed, leaving 6 options in the database
    • theysaidso_admin_options
    • can_compress_scripts
    • widget_theysaidso_widget
    • db_upgraded
    • widget_recent-posts
    • widget_recent-comments

Smoke tests 75% from 4 tests

Server-side errors Passed 1 test

🔹 Test weight: 20 | A smoke test targeting server-side errors
Everything seems fine, however this is by no means an exhaustive test

SRP 50% from 2 tests

🔹 Tests weight: 20 | It is important to ensure that your PHP files perform no action when accessed directly, respecting the single-responsibility principle
Please fix the following items
  • 3× PHP files trigger server errors when accessed directly:
    • > PHP Fatal error
      Uncaught Error: Class 'Michelf\\Markdown' not found in wp-content/plugins/github-readme/Michelf/MarkdownExtra.php:20
    • > PHP Fatal error
      Uncaught Error: Interface 'Michelf\\MarkdownInterface' not found in wp-content/plugins/github-readme/Michelf/Markdown.php:20
    • > PHP Fatal error
      Uncaught Error: Call to undefined function add_shortcode() in wp-content/plugins/github-readme/github-readme.php:15

User-side errors Passed 1 test

🔹 Test weight: 20 | This is a shallow check for browser errors
There were no browser issues found

Optimizations

Plugin configuration 97% from 29 tests

readme.txt 94% from 16 tests

The readme.txt file is an important file in your plugin as it is parsed by WordPress.org to prepare the public listing of your plugin
Please fix the following attributes:
  • Screenshots: Screenshot #1 (Example of the plugin in action on my blog: http://jason.stallin.gs/projects/marknote/) image not found
The official readme.txt is a good inspiration

github-readme/github-readme.php Passed 13 tests

"Github README" version 0.2.0's main PHP file describes plugin functionality and also serves as the entry point to any WordPress functionality
110 characters long description:
Github README is a plugin that allows you to embed a GitHub README in a page or post using a simple shortcode.

Code Analysis Passed 3 tests

File types Passed 1 test

🔸 Test weight: 35 | An overview of files in this plugin; executable files are not allowed
No dangerous file extensions were detected2,142 lines of code in 7 files:
LanguageFilesBlank linesComment linesLines of code
PHP74798902,142

PHP code Passed 2 tests

This is a short overview of cyclomatic complexity and code structure for this plugin
Great job! No cyclomatic complexity issues were detected in this plugin
Cyclomatic complexity
Average complexity per logical line of code0.24
Average class complexity63.33
▷ Minimum class complexity1.00
▷ Maximum class complexity112.00
Average method complexity2.95
▷ Minimum method complexity1.00
▷ Maximum method complexity24.00
Code structure
Namespaces1
Interfaces1
Traits0
Classes2
▷ Abstract classes00.00%
▷ Concrete classes2100.00%
▷ Final classes00.00%
Methods98
▷ Static methods22.04%
▷ Public methods66.12%
▷ Protected methods9293.88%
▷ Private methods00.00%
Functions6
▷ Named functions6100.00%
▷ Anonymous functions00.00%
Constants1
▷ Global constants00.00%
▷ Class constants1100.00%
▷ Public constants1100.00%

Plugin size Passed 2 tests

Image compression Passed 2 tests

Often times overlooked, PNG files can occupy unnecessary space in your plugin
No PNG files were detected