Skip to content

Home

Jump to bottom
Jo Dickson edited this page Feb 3, 2020 · 7 revisions

What are these files?

This template repo is a boilerplate set of files for WordPress plugins, for use in projects created by UCF Communications and Marketing (specifically, UCF Web Communications/Webcom). It includes an opinionated set of build tool and linter configurations for rapid development of minified, optimized plugin assets that follow our team's code standards.

How to create a new plugin repo

To ensure our projects are created with the latest configurations and README information, CM devs should create new plugin projects from this repo. Use the guide below to get started:

Instructions:

  1. Create a new repo in Github using this template.

  2. Pull down your new repo into your local development environment.

  3. Rename my-project.php to use your project's slug.

  4. Replace {{My-Project}} and {{My Project}} placeholders throughout the template files.

    {{My-Project}} corresponds to the the slug of your project on Github, e.g. UCF-News-Plugin.

    {{My Project}} should be replaced with the human-friendly name of your project, e.g. UCF News Plugin.

    You can perform a couple of project-wide find+replace commands in your IDE/editor to do this quickly.

That's it! From here, continue developing your plugin as you would normally. Remember to fill in the remaining placeholder information for your project in the README, CONTRIBUTING doc, and other files! (You can do a project-wide search for {{ to locate all of these placeholders.)

Post-setup checklist:

In addition to setting up your new project on Github using these files, remember to also do the following for all new projects. Some parts of our project documentation depend on the following existing:

Things to know / project assumptions

Projects generated using these template files assume the following:

  • The developer is responsible for setting up registration of ALL project css and js; no enqueuing is included in the template files out-of-the-box
  • Minified css and js will be saved to static/
  • A separate README.md file is generated from the README.txt using the gulp readme command. README.md should not be edited directly.
Clone this wiki locally