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).
1.4 KiB
1.4 KiB
Contributing to WP Plugin Starter
Thank you for helping. Bug reports, fixes and ideas are all welcome.
Reporting a problem
Open an issue with the Bug report form. Include the versions, the steps
and any messages from wp-content/debug.log. Security problems go through
SECURITY.md, never a public issue.
Suggesting a feature
Open an issue with the Feature request form before writing code. Each setting makes a choice for the plugin's users, so a new one has to earn its place: say what the feature does on its own and what problem it solves.
Pull requests
- Read
STANDARDS.md(how features, settings, migrations and front-end styles work, the code rules and testing),AGENTS.md(what is this plugin's own) andDEVELOPMENT.md(set-up and checks). - Keep each pull request to one change. Features are off by default.
- Run
scripts/lint.shand fix what it finds in the code. - Test on a real WordPress site, including WordPress 6.2 with PHP 7.4 if you use a core function, and Kadence light and dark mode if you change front-end styles.
- Add a line to the changelogs:
README.md(details),changelog.txt(for users) andreadme.txt(one short line).
CI runs the checks on every pull request. Write the pull request description so a reviewer knows what changed, why, and how you tested it.
Licence
WP Plugin Starter is GPL-2.0-or-later. By contributing, you agree your work is released under the same licence.