Skip to content

Latest commit

 

History

History
116 lines (67 loc) · 3.65 KB

CONTRIBUTING.md

File metadata and controls

116 lines (67 loc) · 3.65 KB

First off, thanks for taking the time to contribute!

Table of contents

Getting started

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

In order to fully utilize the development environment we recommend you use Visual Studio Code, and have PHP Sniffer extension installed.

Clone the repository:

$ git clone git@github.com:sendsmaily/smaily-woocommerce-plugin.git

Next, change your working directory to the local repository:

$ cd smaily-woocommerce-plugin

Install packages required by the development environment:

$ composer install

And run the environment:

$ docker-compose up

Internals

Structure of the repository

The repository is split into multiple parts:

  • assets - screenshots for Wordpress.org plugin page;
  • inc - classes for providing core and content functionality;
  • lang - localization files;
  • migrations - schema and data migrations;
  • static - CSS, images and Javascript for admin panel and public pages;
  • templates - admin panel and public page templates;
  • vendor - Composer packages.

In addition there are system directories:

  • .github - GitHub issue and pull request templates, and release build pipeline;
  • .vscode - Visual Studio Code settings.

Development

All code written must follow Wordpress' Coding Standards. Including CSS, HTML, Javascript and PHP.

Starting the environment

You can run the environment by executing:

$ docker-compose up

Note! Make sure you do not have any other process(es) listening on ports 8080 and 8888.

Stopping the environment

Environment can be stopped by executing:

$ docker-compose down

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 -v

Migrations

Plugin has built-in feature to run schema and data migrations when plugin version changes.

Creating a migration file

All migrations must be placed inside migrations directory, and named by pattern upgrade-[major]-[minor]-[patch].php. Where major, minor and patch represent the to-be-released version of the plugin.

<?php

/**
 * Migration to make changes to the database schema.
 */

$upgrade = function() {
    // Your migration goes here...
};

Releasing

Releasing a new version of the plugin to Wordpress.org requires SVN client.

Note! Make sure release build has finished in GitHub (smaily-for-woocommerce.zip file should exist in GitHub release assets), before running the release script.

After creating a release in GitHub, plugin must also be deployed to Wordpress.org. The repository contains a handy script for that:

$ ./release.sh -u [Your Wordpress.org username]

It will guide you through the release process step-by-step.