Documentation

HealthyWP aims to become a platform for crowd sourcing good and bad experiences on using or combining plugins in WordPress installations. The analysis of those experiences will be available openly via a user friendly portal, enabling them to build more effective and secure WordPress websites.

On a second level we intend on extending the platform to make use of state of the art software evaluation metrics to provide further information about the source code of the plugins themselves. This way we will help the authors of the plugins focus on usability, security and effectiveness as they extend or maintain them.

Architecture

We have based HealthyWP plugin archtecture to the WordPress Plugin Boilerplate. If you are not familiar with WordPress Pluging Boilerplate you encourage you to have a look at the following, well written guidelines:

• Speed up Development Using the WordPress Plugin Boilerplate
• The WordPress Plugin Boilerplate Part 2: Developing a Plugin

Since most of the functionality is happening to the administration side (WordPress dashboard), the parts of the code that you are probably going to need to work week are the following:

• The admin folder: The place where we put functionality regarding to HealthyWP plugin's page on the dashboard and or other pages of the dashboard.
• The includes/class-healthywp.php file: Here we define the WordPress hooks and filters about both the admin and the public parts.

Features & Tasks

All tasks and features of the project are being defined as issues to this github repository. The project is public so feel free to contribute by adding, commenting, sending pull requests.

We encourage you to take a look at the Read Me Code of conduct and Contributing guidelines to learn more about the project and the community we envision around it.

We are already thrilled to have you aboard!