File: README-ES.md

Recommend this page to a friend!

README-ES.md

File:	`README-ES.md`
Role:	Documentation
Content type:	`text/markdown`
Description:	Documentation
Class:	wp-plugin-rating Show ratings of WordPress plugins
Author:	By Josantonius
Last change:
Date:	6 years ago
Size:	`5,533 bytes`

WP Plugin Rating � Eliasis component

Mostrar la calificaci�n del plugin en las p�ginas de administraci�n de WordPress para plugins desarrollados con Eliasis Framework.

Este componente requiere que la p�gina donde se insertar� el gancho de acci�n haya sido creada con WP_Menu.

<img src="resources/screenshot-1.png" alt="">
<img src="resources/screenshot-2.png" alt="">

</p>

Este componente es soportado por versiones de PHP 5.6 o superiores y es compatible con versiones de HHVM 3.0 o superiores.

La mejor forma de instalar este componente es a trav�s de Composer.

Para instalar WP Plugin Rating, simplemente escribe:

$ composer require eliasis-framework/wp-plugin-rating

El comando anterior s�lo instalar� los archivos necesarios, si prefieres descargar todo el c�digo fuente puedes utilizar:

$ composer require eliasis-framework/wp-plugin-rating --prefer-source

Tambi�n puedes clonar el repositorio completo con Git:

$ git clone https://github.com/eliasis-framework/wp-plugin-rating.git

M�todos disponibles en este componente:

Hook::doAction('get_plugin_rating', $slug);

| Atributo | Descripci�n | Tipo de dato | Requerido | Por defecto | --- | --- | --- | --- | | $slug | Slug del plugin de WordPress. | string | S� |

@return Salida HTML.

Para utilizar este componente con Composer:

use Josantonius\Hook\Hook;

Hook::doAction('get_plugin_rating', 'search-inside');

Para ejecutar las pruebas necesitar�s Composer y seguir los siguientes pasos:

$ git clone https://github.com/eliasis-framework/wp-plugin-rating.git

$ cd wp-plugin-rating

$ composer install

Ejecutar pruebas unitarias con PHPUnit:

$ composer phpunit

Ejecutar pruebas de est�ndares de c�digo para WordPress con PHPCS:

$ composer phpcs

Ejecutar pruebas con PHP Mess Detector para detectar inconsistencias en el estilo de codificaci�n:

$ composer phpmd

Ejecutar todas las pruebas anteriores:

$ composer tests

[ ] A�adir nueva funcionalidad.
[ ] Mejorar pruebas.
[ ] Mejorar documentaci�n.
[ ] Refactorizar c�digo para las reglas de estilo de c�digo deshabilitadas. Ver phpmd.xml y .php_cs.dist.

Si deseas colaborar, puedes echar un vistazo a la lista de issues o tareas pendientes.

Pull requests

Fork and clone.
Ejecuta el comando `composer install` para instalar dependencias. Esto tambi�n instalar� las dependencias de desarrollo.
Ejecuta el comando `composer fix` para estandarizar el c�digo.
Ejecuta las pruebas.
Crea una nueva rama (branch), commit, push y env�ame un pull request.