marcus
2f91c3e6af
The parts every wpallstars plugin needs: settings screen with search and an empty General tab, Read Me tab, features as classes, replaced plugins, the shared GitHub updater, release and check scripts, CI and the shared rules. scripts/rename-plugin.sh starts a new plugin; scripts/sync-core.sh keeps plugins' core files in step with this starter. Built with aidevops (https://aidevops.sh).
52 lines
2.4 KiB
Markdown
52 lines
2.4 KiB
Markdown
# WP Plugin Starter — agent guide
|
|
|
|
The wpallstars starter plugin: what every wpallstars plugin is made from.
|
|
It has no features of its own, only the parts every plugin needs.
|
|
|
|
**Read `STANDARDS.md` before any change.** It holds the rules every plugin
|
|
made from the starter shares: structure and core files, code rules, Updates
|
|
from GitHub, releases, front-end styling and dark mode, and testing. This
|
|
repository holds the master copy of it and of every core file
|
|
(`scripts/core-files.txt`). This file holds only what is the starter's own.
|
|
|
|
| Placeholder in `STANDARDS.md` | WP Plugin Starter |
|
|
|---|---|
|
|
| `{slug}` | `wp-plugin-starter-template` (main file `wp-plugin-starter-template.php`) |
|
|
| `{prefix}` | `wpstarter` |
|
|
| `{Prefix}` | `WPStarter` |
|
|
| `{PREFIX}` | `WPSTARTER` |
|
|
| `{Name}` | WP Plugin Starter |
|
|
| `{css}` | `wps` |
|
|
|
|
User docs: `README.md` (developers, and the Read Me tab) and `readme.txt`.
|
|
Development: `DEVELOPMENT.md`. Releases: `RELEASING.md`; launch state:
|
|
`LAUNCH.md`.
|
|
|
|
## What belongs here
|
|
|
|
- Only what every plugin needs. A part one plugin needs stays in that
|
|
plugin (its `{Prefix}_Setup`, a feature or its own files). When a lesson
|
|
from a plugin applies to all of them, change the core file here first,
|
|
then run `scripts/sync-core.sh` in each plugin (`--check` lists what
|
|
differs). Keep core files free of any one plugin's names, examples and
|
|
paths: this repository is public.
|
|
- `includes/class-wpstarter-setup.php` stays empty of features, so the
|
|
settings screen shows the empty General tab and the Read Me tab. Test a
|
|
core change in a plugin that uses it, then here.
|
|
- `scripts/rename-plugin.sh` must keep working on a fresh copy: after a
|
|
change to names in core files, try it on a throwaway clone (rename, lint,
|
|
smoke test).
|
|
- The banner source is `.wordpress-org/banner.svg`: the wpallstars plugin
|
|
stack picture in red only, on wpallstars branding. Rebuild it with
|
|
`scripts/build-banner.sh`.
|
|
- This repository is public. Never name private repositories, their
|
|
issues, or local paths in it (commits, docs, comments or examples).
|
|
- Every plugin made from the starter keeps the **Built with AI** credit to
|
|
aidevops (https://aidevops.sh) in `README.md` and `readme.txt`.
|
|
|
|
## Test sites
|
|
|
|
Install the GitHub build on a local test site with
|
|
`scripts/preview-site.sh` (see `DEVELOPMENT.md`), or install the GitHub
|
|
zip from `scripts/build-release.sh` on any test site.
|