3.6 KiB
AI Assistant Guide for WordPress Plugin Development
This guide helps AI assistants understand the project structure, workflows, and best practices for this repository.
Project Overview
- Plugin Name: Fix 'Plugin file does not exist' Notices
- Repository: https://github.com/wpallstars/wp-fix-plugin-does-not-exist-notices
- Description: Adds missing plugins to your plugins list with a "Remove Notice" action link, allowing you to safely clean up invalid plugin references.
This plugin helps users clean up references to deleted plugins that cause "Plugin file does not exist" errors in the WordPress admin. It adds missing plugins to the plugins list with a "Remove Notice" link to safely remove invalid plugin entries.
AI Workflows
Detailed workflow documentation is available in the .ai-workflows/
directory:
- @.ai-workflows/bug-fixing.md: Guidelines for identifying and fixing bugs
- @.ai-workflows/code-review.md: Standards for reviewing code changes
- @.ai-workflows/feature-development.md: Process for developing new features
- @.ai-workflows/folder-structure.md: Documentation of the plugin's folder structure and naming conventions
- @.ai-workflows/local-env-vars.md: Local development environment paths and URLs
- @.ai-workflows/release-process.md: Steps for preparing and publishing releases
Version Management
We follow Semantic Versioning:
- MAJOR.MINOR.PATCH (e.g., 2.2.2)
- MAJOR: Breaking changes
- MINOR: New features, non-breaking
- PATCH: Bug fixes, non-breaking
When updating version numbers, see @.ai-workflows/release-process.md for the complete checklist.
IMPORTANT: Always keep the changelogs in README.md, readme.txt, and CHANGELOG.md in sync to avoid confusion. All three files must be updated with the same changes for each release.
Git Workflow
Branch Naming Convention
- Feature branches:
feature/descriptive-name
- Bug fix branches:
fix/issue-description
- Release branches:
v{MAJOR}.{MINOR}.{PATCH}
Commit Message Guidelines
- Use present tense ("Add feature" not "Added feature")
- Start with a verb
- Keep the first line under 50 characters
- Reference issues when relevant: "Fix #123: Resolve plugin detection issue"
Remote Repositories
The plugin is hosted on multiple repositories:
- GitHub: https://github.com/wpallstars/wp-fix-plugin-does-not-exist-notices
- Gitea: https://gitea.wpallstars.com/wpallstars/wp-fix-plugin-does-not-exist-notices
- WordPress.org: https://wordpress.org/plugins/wp-fix-plugin-does-not-exist-notices/
Always push changes to all remotes to keep them in sync.
Git Updater Integration
The plugin integrates with Git Updater to allow updates directly from GitHub or Gitea. Important notes:
- Git Updater reads version information from the readme.txt file in the main branch, not from tags or releases
- Always merge release changes to the main branch immediately after creating a tag
- The plugin includes proper headers for Git Updater in the main plugin file
See @.ai-workflows/release-process.md for detailed Git Updater integration steps.
Testing Guidelines
Before releasing:
- Test with the latest WordPress version
- Test with PHP 7.0+ (minimum supported version)
- Verify all features work as expected
- Check for any PHP warnings or notices
Local environment variables and paths are documented in @.ai-workflows/local-env-vars.md.
Common Tasks
For detailed instructions on common tasks like creating releases, adding features, fixing bugs, and testing previous versions, see @.ai-workflows/release-process.md.