Skip to content

Latest commit

 

History

History
18 lines (13 loc) · 1.44 KB

README.md

File metadata and controls

18 lines (13 loc) · 1.44 KB

Newspack starter template for custom plugins

This template is a pre-configured starting point for custom plugin development on the Newspack platform. It will give you all of the tools you needs to get up and running quickly.

What does it provide?

  1. A pre-configured build process provided by the @wordpress/scripts package. This is the standard build process for WordPress. For more information on configuration and options, please see the official documentation.
  2. A PHP CodeSniffer configuration that will check your code against the coding standards that are recommended by the Newspack team.
  3. A Prettier configuration for WordPress.
  4. A Husky configuration to lint local files changes before they are committed.
  5. A GitHub action to check that your commits and merges adhere to the correct coding standards
  6. A GitHub action to automatically deploy your changes to the production environment when merged to trunk.
  7. A GitHub action to automatically deploy your changes to the staging environment when pushing to the staging branch.

How do I use it?

Please refer to How to set up the Newspack Starter Template for custom plugins on help.newspack.com for up-to-date installation and setup instructions.