Skip to content

Latest commit

 

History

History
109 lines (67 loc) · 4.04 KB

contributing.md

File metadata and controls

109 lines (67 loc) · 4.04 KB
Raw

First off, thanks for taking the time to contribute!

Table of contents

Getting started

The development environment requires Docker and Docker Compose to run. Please refer to the official documentation for step-by-step installation guide.

Clone the repository:

$ git clone [email protected]:sendsmaily/smaily-wordpress-plugin.git

Next, change your working directory to the local repository:

$ cd smaily-wordpress-plugin

And run the environment:

$ docker compose up -d

During first run WordPress installation wizard guides you through the setup process. After completing the installation, the site can be accessed from http://localhost:8080 and the administration interface from http://localhost:8080/wp-admin URL.

Internals

Structure of the repository

The repository is split into multiple parts:

  • admin - administrator interface related components;
  • blocks - Gutenberg blocks components;
  • cf7 - Contact Form 7 plugin integration;
  • gfx - illustrations & media;
  • includes - functionality separated into class based components;
  • languages - translations;
  • logs - folder to store plugin logs;
  • migrations - database migrations during plugin upgrade;
  • public - public frontend interface related components;
  • woocommerce - WooCommerce plugin integration;

Development

Documentation about WordPress coding standards and plugin development can be found in the WordPress development resources.

Starting the environment

You can run the environment by executing:

$ docker compose up -d

Note! Make sure you do not have any other process(es) listening on ports 8080, 8888 and 8025. Port 8888 is used by phpmyadmin and port 8025 is used by the mailhog service.

Stopping the environment

Environment can be stopped by executing:

$ docker compose down --remove-orphans

Resetting the environment

If you need to reset the installation, just simply delete environment's Docker volumes. Easiest way to achieve this is by running:

$ docker compose down --remove-orphans --volumes

Developing the plugin

Development options

This module can be developed both locally and in a containerized environment. Visual Studio Code offers support for developing the plugin inside a remote container, providing the following benefits:

  • IntelliSense Support: Access to IntelliSense for WordPress internal functions, enhancing the development experience.
  • Seamless Environment: The remote container replicates the WordPress environment, reducing compatibility issues.

For quick edits or when a remote container is not required, you can also modify the files directly on your local machine. These changes will be immediately reflected in the running WordPress instance.

Code Sniffing and Linting

This repository uses PHP CodeSniffer with specific rules defined in the phpcs.xml file. To run the code sniffer locally, you need to have Composer installed. The remote container environment is already set up with Composer.

To install PHP CodeSniffer and the required coding standards, run the following command:

$ composer install

Note! When running the command inside container the vendor directory is created with root permissions. This may cause issues when executing Composer-related functions locally afterwards.

You can check for linting errors by executing:

$ composer run lint

Some reported errors can be automatically fixed. To apply these fixes, run:

$ composer run format