Skip to content

Latest commit

 

History

History
86 lines (51 loc) · 2.07 KB

README.md

File metadata and controls

86 lines (51 loc) · 2.07 KB
Raw

PublishPress Checklists

Description

Extend PublishPress implementing a list of requirements to publish posts.

Documentation

https://publishpress.com/docs/

Guidelines

  • Write a clear summary
  • Write precise steps to reproduce

Installation

⚠️ Warning! This plugin requires to be built before being installed!

This repository doesn't store external dependencies required by the plugin. It's not possible to simply clone or download the repository code and have a working WordPress plugin.

We aim to follow good practices on development, and we are using Composer as dependency manager, which recommends to not add external dependencies into the repository. You can find more information on their documentation page: Should I commit the dependencies in my vendor directory?

How to install?

You can download a built package from releases page and install it on your WordPress sites by uploading the zip file.

How to build a package?

Please, check the instructions on our documentation pages.

How to contribute with code

  • Clone the repository
  • Create a new branch
  • Implement and commit the code
  • Create a Pull Request targetting the "development" branch adding details about your fix

We will review and contact you as soon as possible.

Development

Setup

Before starting developing you need to install some dependencies managed by composer and npm. Make sure you have composer and npm installed and working.

$ composer update
$ npm install

React

Compiling JSX files to JS

While developing you can set webpack to watch for file changes:

$ npm run dev

For building the package for production:

$ npm run build

Building

Changing the version number

$ phing set-version

Building the package

$ phing build

License

License: GPLv2 or later