wpallstars/wp-plugin-starter-template-for-ai-coding
Template
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge v0.1.10 into main

Browse Source
This commit is contained in:
Marcus Quinn
2025-04-19 21:56:40 +01:00
parent 45feb7b550 a885ef1e0b
commit 6031751015
18 changed files with 157 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
.ai-workflows/code-review.md
View File

@@ -62,6 +62,7 @@ When reviewing code, check for the following:
### 1. Understand the Context ### 1. Understand the Context
Before reviewing code, understand: Before reviewing code, understand:
- What problem is the code trying to solve? - What problem is the code trying to solve?
- What are the requirements? - What are the requirements?
- What are the constraints? - What are the constraints?
@@ -73,6 +74,7 @@ Review the code with the checklist above in mind.
### 3. Provide Feedback ### 3. Provide Feedback
When providing feedback: When providing feedback:
- Be specific and clear - Be specific and clear
- Explain why a change is needed - Explain why a change is needed
- Provide examples or suggestions when possible - Provide examples or suggestions when possible
@@ -82,6 +84,7 @@ When providing feedback:
### 4. Follow Up ### 4. Follow Up
After the code has been updated: After the code has been updated:
- Review the changes - Review the changes
- Verify that issues have been addressed - Verify that issues have been addressed
- Provide additional feedback if necessary - Provide additional feedback if necessary

4
.ai-workflows/incremental-development.md
View File

@@ -39,6 +39,7 @@ This document provides guidance for AI assistants to help with incremental devel
### Marking Stable Versions ### Marking Stable Versions
When the user confirms that changes are working correctly: When the user confirms that changes are working correctly:
1. Create a version branch and update version numbers 1. Create a version branch and update version numbers
2. Tag the version branch as stable 2. Tag the version branch as stable
```bash ```bash
@@ -62,6 +63,7 @@ git checkout -b fix/plugin-activation-error
### 2. Make Changes Without Updating Version Numbers ### 2. Make Changes Without Updating Version Numbers
During the development and testing phase: During the development and testing phase:
- Implement the necessary changes - Implement the necessary changes
- **Don't update version numbers** in any files yet - **Don't update version numbers** in any files yet
- Focus on the functionality - Focus on the functionality
@@ -79,6 +81,7 @@ CURRENT_VERSION=$(grep -o "Version: [0-9.]*" wp-fix-plugin-does-not-exist-notice
``` ```
This will: This will:
1. Create a build directory 1. Create a build directory
2. Copy required files to the build directory 2. Copy required files to the build directory
3. Deploy the plugin to your local WordPress testing environment 3. Deploy the plugin to your local WordPress testing environment
@@ -88,6 +91,7 @@ This will:
### 4. Test and Evaluate ### 4. Test and Evaluate
Test the changes thoroughly in the local environment: Test the changes thoroughly in the local environment:
- Verify that the specific issue is fixed or feature works as expected - Verify that the specific issue is fixed or feature works as expected
- Check for any regressions or new issues - Check for any regressions or new issues
- Document the results - Document the results

13
.ai-workflows/local-env-vars.md
View File

@@ -3,17 +3,20 @@
This file contains important paths and URLs for local development. This file contains important paths and URLs for local development.
## Repository Paths ## Repository Paths
- Local development repository: ~/Git/wp-fix-plugin-does-not-exist-notices - Local development repository: ~/Git/wp-fix-plugin-does-not-exist-notices
- LocalWP plugin testing site storage: ~/Local/plugin-testing/app/wp-fix-plugin-does-not-exist-notices - LocalWP plugin testing site storage: ~/Local/plugin-testing/app/wp-fix-plugin-does-not-exist-notices
- LocalWP plugin testing site configuration: ~/Local/plugin-testing/conf/ - LocalWP plugin testing site configuration: ~/Local/plugin-testing/conf/
## URLs ## URLs
- LocalWP plugin testing URL: http://plugin-testing.local/
- PHP details: http://plugin-testing.local/local-phpinfo.php - LocalWP plugin testing URL: <http://plugin-testing.local/>
- XDebug info: http://plugin-testing.local/local-xdebuginfo.php - PHP details: <http://plugin-testing.local/local-phpinfo.php>
- Adminer Evo: http://localhost:10010/?username=root&db=local - XDebug info: <http://plugin-testing.local/local-xdebuginfo.php>
- Mailpit: http://localhost:10000/ - Adminer Evo: <http://localhost:10010/?username=root&db=local>
- Mailpit: <http://localhost:10000/>
## Build and Deploy Scripts ## Build and Deploy Scripts
- Build script: ~/Git/wp-fix-plugin-does-not-exist-notices/build.sh - Build script: ~/Git/wp-fix-plugin-does-not-exist-notices/build.sh
- Local deploy script: ~/Git/wp-fix-plugin-does-not-exist-notices/deploy-local.sh - Local deploy script: ~/Git/wp-fix-plugin-does-not-exist-notices/deploy-local.sh

2
.ai-workflows/multi-repo-workspace.md
View File

@@ -36,6 +36,7 @@ Suggesting changes or improvements based on other repositories, leading to scope
### 1. Repository Verification ### 1. Repository Verification
**ALWAYS** verify which repository you're currently working in before: **ALWAYS** verify which repository you're currently working in before:
- Making code suggestions - Making code suggestions
- Creating or updating documentation - Creating or updating documentation
- Discussing features or functionality - Discussing features or functionality
@@ -44,6 +45,7 @@ Suggesting changes or improvements based on other repositories, leading to scope
### 2. Explicit Code Search Scoping ### 2. Explicit Code Search Scoping
When searching for code or functionality: When searching for code or functionality:
- Explicitly limit searches to the current repository - Explicitly limit searches to the current repository
- Use repository-specific paths in search queries - Use repository-specific paths in search queries
- Verify search results are from the current repository before using them - Verify search results are from the current repository before using them

3
.ai-workflows/release-process.md
View File

@@ -57,11 +57,13 @@ Build the plugin with the new version:
``` ```
This will: This will:
- Create a clean build in the `build/` directory - Create a clean build in the `build/` directory
- Generate a ZIP file for distribution - Generate a ZIP file for distribution
- Deploy to a local WordPress installation if configured - Deploy to a local WordPress installation if configured
Test the plugin thoroughly: Test the plugin thoroughly:
- Test with the latest WordPress version - Test with the latest WordPress version
- Test with the minimum supported WordPress version (5.0) - Test with the minimum supported WordPress version (5.0)
- Test with PHP 7.0+ (minimum supported version) - Test with PHP 7.0+ (minimum supported version)
@@ -139,6 +141,7 @@ Follow semantic versioning (MAJOR.MINOR.PATCH):
- **PATCH**: Backward-compatible bug fixes - **PATCH**: Backward-compatible bug fixes
Examples: Examples:
- Bug fix: 1.0.0 → 1.0.1 - Bug fix: 1.0.0 → 1.0.1
- New feature: 1.0.0 → 1.1.0 - New feature: 1.0.0 → 1.1.0
- Breaking change: 1.0.0 → 2.0.0 - Breaking change: 1.0.0 → 2.0.0

15
.wiki/Changelog.md
View File

@@ -3,42 +3,57 @@
This page documents all notable changes to the WordPress Plugin Starter Template. This page documents all notable changes to the WordPress Plugin Starter Template.
## Version 0.1.6 (2025-04-19) ## Version 0.1.6 (2025-04-19)
### Fixed ### Fixed
- GitHub Actions workflows permissions for releases and wiki sync - GitHub Actions workflows permissions for releases and wiki sync
## Version 0.1.5 (2025-04-19) ## Version 0.1.5 (2025-04-19)
### Fixed ### Fixed
- Release workflow to use correct plugin directory name - Release workflow to use correct plugin directory name
### Added ### Added
- Testing setup with wp-env and Cypress - Testing setup with wp-env and Cypress
- Multisite compatibility - Multisite compatibility
- npm scripts for development and testing - npm scripts for development and testing
## Version 0.1.3 (2025-04-19) ## Version 0.1.3 (2025-04-19)
### Added ### Added
- Improved AI IDE context recommendations in documentation - Improved AI IDE context recommendations in documentation
- Enhanced Starter Prompt with guidance on pinning .ai-assistant.md and .ai-workflows/ - Enhanced Starter Prompt with guidance on pinning .ai-assistant.md and .ai-workflows/
### Changed ### Changed
- Updated README.md and readme.txt with AI IDE context recommendations - Updated README.md and readme.txt with AI IDE context recommendations
- Improved documentation for AI-assisted development - Improved documentation for AI-assisted development
- Moved Starter Prompt to the wiki for better organization - Moved Starter Prompt to the wiki for better organization
## Version 0.1.2 (2025-04-18) ## Version 0.1.2 (2025-04-18)
### Added ### Added
- STARTER-PROMPT.md with comprehensive guide for customizing the template - STARTER-PROMPT.md with comprehensive guide for customizing the template
- Additional AI workflow files for better development guidance - Additional AI workflow files for better development guidance
### Changed ### Changed
- Updated documentation files with improved instructions - Updated documentation files with improved instructions
## Version 0.1.1 (2025-04-18) ## Version 0.1.1 (2025-04-18)
### Changed ### Changed
- Updated LICENSE file with correct GPL-2.0 text - Updated LICENSE file with correct GPL-2.0 text
## Version 0.1.0 (2025-04-17) ## Version 0.1.0 (2025-04-17)
### Added ### Added
- Initial release with basic template structure - Initial release with basic template structure
- Core plugin architecture with OOP approach - Core plugin architecture with OOP approach
- Admin interface components and styling - Admin interface components and styling

1
.wiki/Frequently-Asked-Questions.md
View File

@@ -11,6 +11,7 @@ The WordPress Plugin Starter Template is a comprehensive starting point for deve
### Who is this template for? ### Who is this template for?
This template is designed for: This template is designed for:
- WordPress plugin developers looking for a solid foundation - WordPress plugin developers looking for a solid foundation
- Developers who want to leverage AI assistance in their development workflow - Developers who want to leverage AI assistance in their development workflow
- Anyone who wants to create a WordPress plugin following best practices - Anyone who wants to create a WordPress plugin following best practices

14
.wiki/Troubleshooting.md
View File

@@ -9,6 +9,7 @@ This guide provides solutions to common issues you might encounter when using or
**Problem**: The plugin fails to install in WordPress. **Problem**: The plugin fails to install in WordPress.
**Solutions**: **Solutions**:
1. Verify that your WordPress version meets the minimum requirement (5.0+) 1. Verify that your WordPress version meets the minimum requirement (5.0+)
2. Check that your PHP version meets the minimum requirement (7.0+) 2. Check that your PHP version meets the minimum requirement (7.0+)
3. Ensure the ZIP file is properly formatted and contains all required files 3. Ensure the ZIP file is properly formatted and contains all required files
@@ -19,6 +20,7 @@ This guide provides solutions to common issues you might encounter when using or
**Problem**: You receive an error when activating the plugin. **Problem**: You receive an error when activating the plugin.
**Solutions**: **Solutions**:
1. Check the error message for specific details 1. Check the error message for specific details
2. Verify that all plugin dependencies are installed and activated 2. Verify that all plugin dependencies are installed and activated
3. Check your server's error logs for more information 3. Check your server's error logs for more information
@@ -31,6 +33,7 @@ This guide provides solutions to common issues you might encounter when using or
**Problem**: Composer fails to install dependencies. **Problem**: Composer fails to install dependencies.
**Solutions**: **Solutions**:
1. Verify that you have Composer installed and up to date 1. Verify that you have Composer installed and up to date
2. Check that your PHP version meets the requirements for all dependencies 2. Check that your PHP version meets the requirements for all dependencies
3. Try clearing Composer's cache: `composer clear-cache` 3. Try clearing Composer's cache: `composer clear-cache`
@@ -41,6 +44,7 @@ This guide provides solutions to common issues you might encounter when using or
**Problem**: NPM fails to install dependencies. **Problem**: NPM fails to install dependencies.
**Solutions**: **Solutions**:
1. Verify that you have Node.js and NPM installed and up to date 1. Verify that you have Node.js and NPM installed and up to date
2. Try clearing NPM's cache: `npm cache clean --force` 2. Try clearing NPM's cache: `npm cache clean --force`
3. Delete the `node_modules` directory and run `npm install` again 3. Delete the `node_modules` directory and run `npm install` again
@@ -51,6 +55,7 @@ This guide provides solutions to common issues you might encounter when using or
**Problem**: The WordPress environment fails to start. **Problem**: The WordPress environment fails to start.
**Solutions**: **Solutions**:
1. Verify that Docker is installed and running 1. Verify that Docker is installed and running
2. Check that the Docker daemon has enough resources allocated 2. Check that the Docker daemon has enough resources allocated
3. Try stopping and removing existing containers: `npm run wp-env stop && npm run wp-env clean` 3. Try stopping and removing existing containers: `npm run wp-env stop && npm run wp-env clean`
@@ -61,6 +66,7 @@ This guide provides solutions to common issues you might encounter when using or
**Problem**: Unit tests are failing. **Problem**: Unit tests are failing.
**Solutions**: **Solutions**:
1. Verify that you have PHPUnit installed and configured correctly 1. Verify that you have PHPUnit installed and configured correctly
2. Check that all dependencies are installed: `composer install` 2. Check that all dependencies are installed: `composer install`
3. Run tests with verbose output: `./vendor/bin/phpunit --verbose` 3. Run tests with verbose output: `./vendor/bin/phpunit --verbose`
@@ -71,6 +77,7 @@ This guide provides solutions to common issues you might encounter when using or
**Problem**: End-to-end tests are failing. **Problem**: End-to-end tests are failing.
**Solutions**: **Solutions**:
1. Verify that the WordPress environment is running: `npm run start` 1. Verify that the WordPress environment is running: `npm run start`
2. Check that Cypress is installed correctly: `npx cypress verify` 2. Check that Cypress is installed correctly: `npx cypress verify`
3. Run tests in interactive mode to debug: `npm run test:e2e` 3. Run tests in interactive mode to debug: `npm run test:e2e`
@@ -83,6 +90,7 @@ This guide provides solutions to common issues you might encounter when using or
**Problem**: Changes to plugin settings are not being saved. **Problem**: Changes to plugin settings are not being saved.
**Solutions**: **Solutions**:
1. Check for JavaScript errors in the browser console 1. Check for JavaScript errors in the browser console
2. Verify that the settings form is submitting correctly 2. Verify that the settings form is submitting correctly
3. Check that the WordPress nonce is being verified correctly 3. Check that the WordPress nonce is being verified correctly
@@ -93,6 +101,7 @@ This guide provides solutions to common issues you might encounter when using or
**Problem**: The plugin conflicts with other plugins. **Problem**: The plugin conflicts with other plugins.
**Solutions**: **Solutions**:
1. Deactivate other plugins one by one to identify the conflict 1. Deactivate other plugins one by one to identify the conflict
2. Check for JavaScript errors in the browser console 2. Check for JavaScript errors in the browser console
3. Check for PHP errors in the server logs 3. Check for PHP errors in the server logs
@@ -103,6 +112,7 @@ This guide provides solutions to common issues you might encounter when using or
**Problem**: The plugin is causing performance issues. **Problem**: The plugin is causing performance issues.
**Solutions**: **Solutions**:
1. Check if the plugin is making excessive database queries 1. Check if the plugin is making excessive database queries
2. Verify that assets (CSS/JS) are being properly enqueued and minified 2. Verify that assets (CSS/JS) are being properly enqueued and minified
3. Consider implementing caching for resource-intensive operations 3. Consider implementing caching for resource-intensive operations
@@ -115,6 +125,7 @@ This guide provides solutions to common issues you might encounter when using or
**Problem**: The plugin fails to update. **Problem**: The plugin fails to update.
**Solutions**: **Solutions**:
1. Verify that your WordPress version meets the requirements for the new version 1. Verify that your WordPress version meets the requirements for the new version
2. Check that your PHP version meets the requirements for the new version 2. Check that your PHP version meets the requirements for the new version
3. Try updating manually by downloading the new version and replacing the old files 3. Try updating manually by downloading the new version and replacing the old files
@@ -125,6 +136,7 @@ This guide provides solutions to common issues you might encounter when using or
**Problem**: Plugin settings are lost after updating. **Problem**: Plugin settings are lost after updating.
**Solutions**: **Solutions**:
1. Check if the plugin includes a data migration process for updates 1. Check if the plugin includes a data migration process for updates
2. Verify that the settings are being stored in the database correctly 2. Verify that the settings are being stored in the database correctly
3. Restore settings from a backup if available 3. Restore settings from a backup if available
@@ -137,6 +149,7 @@ This guide provides solutions to common issues you might encounter when using or
**Problem**: The plugin doesn't work correctly on a multisite installation. **Problem**: The plugin doesn't work correctly on a multisite installation.
**Solutions**: **Solutions**:
1. Verify that the plugin is network activated if required 1. Verify that the plugin is network activated if required
2. Check that the plugin is compatible with multisite (it should be!) 2. Check that the plugin is compatible with multisite (it should be!)
3. Ensure that the plugin has the necessary permissions on each site 3. Ensure that the plugin has the necessary permissions on each site
@@ -162,6 +175,7 @@ If you've identified a bug in the plugin:
5. Submit the issue 5. Submit the issue
Please include: Please include:
- A clear description of the bug - A clear description of the bug
- Steps to reproduce the issue - Steps to reproduce the issue
- Your environment details (WordPress version, PHP version, etc.) - Your environment details (WordPress version, PHP version, etc.)

4
.wiki/_Sidebar.md
View File

@@ -1,4 +1,5 @@
## User Documentation ## User Documentation
* [Home](Home) * [Home](Home)
* [Starter Prompt](Starter-Prompt) * [Starter Prompt](Starter-Prompt)
* [Installation Guide](Installation-Guide) * [Installation Guide](Installation-Guide)
@@ -7,6 +8,7 @@
* [Troubleshooting](Troubleshooting) * [Troubleshooting](Troubleshooting)
## Developer Documentation ## Developer Documentation
* [Architecture Overview](Architecture-Overview) * [Architecture Overview](Architecture-Overview)
* [Customization Guide](Customization-Guide) * [Customization Guide](Customization-Guide)
* [Extending the Plugin](Extending-the-Plugin) * [Extending the Plugin](Extending-the-Plugin)
@@ -14,8 +16,10 @@
* [Release Process](Release-Process) * [Release Process](Release-Process)
## AI Documentation ## AI Documentation
* [AI Workflow Documentation](AI-Workflow-Documentation) * [AI Workflow Documentation](AI-Workflow-Documentation)
## Additional Resources ## Additional Resources
* [Changelog](Changelog) * [Changelog](Changelog)
* [Contributing](Contributing) * [Contributing](Contributing)

30
CHANGELOG.md
View File

@@ -1,57 +1,87 @@
All notable changes to this project should be documented both here and in the main Readme files. All notable changes to this project should be documented both here and in the main Readme files.
#### [0.1.10] - 2025-04-20
#### Fixed
- Fixed formatting issues in markdown files for better code quality
- Improved URL formatting with angle brackets
- Standardized list formatting across documentation files
#### [0.1.9] - 2025-04-18 #### [0.1.9] - 2025-04-18
#### Changed #### Changed
- Alphabetized AI IDE list in README.md - Alphabetized AI IDE list in README.md
#### [0.1.8] - 2025-04-19 #### [0.1.8] - 2025-04-19
#### Added #### Added
- More informative badges to README.md (Build Status, Requirements, WP.org placeholders, Release, Issues, Contributors, Wiki). - More informative badges to README.md (Build Status, Requirements, WP.org placeholders, Release, Issues, Contributors, Wiki).
#### [0.1.7] - 2025-04-19 #### [0.1.7] - 2025-04-19
#### Fixed #### Fixed
- GitHub Actions tests workflow with proper file paths and dependencies - GitHub Actions tests workflow with proper file paths and dependencies
#### Improved #### Improved
- Workflow names for better clarity in GitHub Actions UI - Workflow names for better clarity in GitHub Actions UI
#### [0.1.6] - 2025-04-19 #### [0.1.6] - 2025-04-19
#### Fixed #### Fixed
- GitHub Actions workflows permissions for releases and wiki sync - GitHub Actions workflows permissions for releases and wiki sync
#### [0.1.5] - 2025-04-19 #### [0.1.5] - 2025-04-19
#### Fixed #### Fixed
- Release workflow to use correct plugin directory name - Release workflow to use correct plugin directory name
#### Added #### Added
- Testing setup with wp-env and Cypress - Testing setup with wp-env and Cypress
- Multisite compatibility - Multisite compatibility
- npm scripts for development and testing - npm scripts for development and testing
#### [0.1.3] - 2025-04-19 #### [0.1.3] - 2025-04-19
#### Added #### Added
- Improved AI IDE context recommendations in documentation - Improved AI IDE context recommendations in documentation
- Enhanced Starter Prompt with guidance on pinning .ai-assistant.md and .ai-workflows/ - Enhanced Starter Prompt with guidance on pinning .ai-assistant.md and .ai-workflows/
#### Changed #### Changed
- Updated README.md and readme.txt with AI IDE context recommendations - Updated README.md and readme.txt with AI IDE context recommendations
- Improved documentation for AI-assisted development - Improved documentation for AI-assisted development
- Moved Starter Prompt to the wiki for better organization - Moved Starter Prompt to the wiki for better organization
#### [0.1.2] - 2025-04-18 #### [0.1.2] - 2025-04-18
#### Added #### Added
- STARTER-PROMPT.md with comprehensive guide for customizing the template - STARTER-PROMPT.md with comprehensive guide for customizing the template
- Additional AI workflow files for better development guidance - Additional AI workflow files for better development guidance
#### Changed #### Changed
- Updated documentation files with improved instructions - Updated documentation files with improved instructions
#### [0.1.1] - 2025-04-18 #### [0.1.1] - 2025-04-18
#### Changed #### Changed
- Updated LICENSE file with correct GPL-2.0 text - Updated LICENSE file with correct GPL-2.0 text
#### [0.1.0] - 2025-04-17 #### [0.1.0] - 2025-04-17
#### Added #### Added
- Initial release with basic template structure - Initial release with basic template structure
- Core plugin architecture with OOP approach - Core plugin architecture with OOP approach
- Admin interface components and styling - Admin interface components and styling

46
README.md
View File

@@ -1,6 +1,6 @@
# WordPress Plugin Starter Template for AI Coding # WordPress Plugin Starter Template for AI Coding
[![License](https://img.shields.io/badge/license-GPL--2.0%2B-blue.svg)](https://www.gnu.org/licenses/gpl-2.0.html) [![Build Status](https://github.com/wpallstars/wp-plugin-starter-template-for-ai-coding/actions/workflows/tests.yml/badge.svg)](https://github.com/wpallstars/wp-plugin-starter-template-for-ai-coding/actions/workflows/tests.yml) [![Requires PHP](https://img.shields.io/badge/php-%3E%3D%207.4-blue.svg)](https://wordpress.org/about/requirements/) [![Requires WordPress](https://img.shields.io/badge/WordPress-%3E%3D%205.0-blue.svg)](https://wordpress.org/about/requirements/) [![Tested up to](https://img.shields.io/wordpress/plugin/tested/your-plugin-slug.svg)](https://wordpress.org/plugins/your-plugin-slug/) [![WordPress rating](https://img.shields.io/wordpress/plugin/r/your-plugin-slug.svg)](https://wordpress.org/plugins/your-plugin-slug/reviews/) [![WordPress downloads](https://img.shields.io/wordpress/plugin/dt/your-plugin-slug.svg)](https://wordpress.org/plugins/your-plugin-slug/) [![Latest Release](https://img.shields.io/github/v/release/wpallstars/wp-plugin-starter-template-for-ai-coding)](https://github.com/wpallstars/wp-plugin-starter-template-for-ai-coding/releases) [![GitHub issues](https://img.shields.io/github/issues/wpallstars/wp-plugin-starter-template-for-ai-coding)](https://github.com/wpallstars/wp-plugin-starter-template-for-ai-coding/issues) [![GitHub contributors](https://img.shields.io/github/contributors/wpallstars/wp-plugin-starter-template-for-ai-coding)](https://github.com/wpallstars/wp-plugin-starter-template-for-ai-coding/graphs/contributors) [![Wiki](https://img.shields.io/badge/documentation-wiki-blue.svg)](https://github.com/wpallstars/wp-plugin-starter-template-for-ai-coding/wiki) [![License](https://img.shields.io/badge/license-GPL--2.0%2B-blue.svg)](https://www.gnu.org/licenses/gpl-2.0.html) [![Build Status](https://github.com/wpallstars/wp-plugin-starter-template-for-ai-coding/actions/workflows/tests.yml/badge.svg)](https://github.com/wpallstars/wp-plugin-starter-template-for-ai-coding/actions/workflows/tests.yml) [![Requires PHP](https://img.shields.io/badge/php-%3E%3D%207.4-blue.svg)](https://wordpress.org/about/requirements/) [![Requires WordPress](https://img.shields.io/badge/WordPress-%3E%3D%205.0-blue.svg)](https://wordpress.org/about/requirements/) [![Tested up to](https://img.shields.io/wordpress/plugin/tested/your-plugin-slug.svg)](https://wordpress.org/plugins/your-plugin-slug/) [![WordPress rating](https://img.shields.io/wordpress/plugin/r/your-plugin-slug.svg)](https://wordpress.org/plugins/your-plugin-slug/reviews/) [![WordPress downloads](https://img.shields.io/wordpress/plugin/dt/your-plugin-slug.svg)](https://wordpress.org/plugins/your-plugin-slug/) [![Latest Release](https://img.shields.io/github/v/release/wpallstars/wp-plugin-starter-template-for-ai-coding)](https://github.com/wpallstars/wp-plugin-starter-template-for-ai-coding/releases) [![GitHub issues](https://img.shields.io/github/issues/wpallstars/wp-plugin-starter-template-for-ai-coding)](https://github.com/wpallstars/wp-plugin-starter-template-for-ai-coding/issues) [![GitHub contributors](https://img.shields.io/github/contributors/wpallstars/wp-plugin-starter-template-for-ai-coding)](https://github.com/wpallstars/wp-plugin-starter-template-for-ai-coding/graphs/contributors) [![Wiki](https://img.shields.io/badge/documentation-wiki-blue.svg)](https://github.com/wpallstars/wp-plugin-starter-template-for-ai-coding/wiki) ![CodeRabbit Pull Request Reviews](https://img.shields.io/coderabbit/prs/github/wpallstars/wp-plugin-starter-template-for-ai-coding?utm_source=oss&utm_medium=github&utm_campaign=wpallstars%2Fwp-plugin-starter-template-for-ai-coding&labelColor=171717&color=FF570A&link=https%3A%2F%2Fcoderabbit.ai&label=CodeRabbit+Reviews) [![CodeFactor](https://www.codefactor.io/repository/github/wpallstars/wp-plugin-starter-template-for-ai-coding/badge)](https://www.codefactor.io/repository/github/wpallstars/wp-plugin-starter-template-for-ai-coding) [![SonarQube Cloud](https://sonarcloud.io/images/project_badges/sonarcloud-highlight.svg)](https://sonarcloud.io/summary/new_code?id=wpallstars_wp-plugin-starter-template-for-ai-coding) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/905754fd010b481490b496fb800e6144)](https://app.codacy.com/gh/wpallstars/wp-plugin-starter-template-for-ai-coding/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
A comprehensive starter template for WordPress plugins with best practices for AI-assisted development. A comprehensive starter template for WordPress plugins with best practices for AI-assisted development.
@@ -90,7 +90,7 @@ This template includes configuration for WordPress Environment (wp-env) to make
npm run multisite npm run multisite
``` ```
4. Access your local WordPress site at http://localhost:8888 (admin credentials: admin/password) 4. Access your local WordPress site at <http://localhost:8888> (admin credentials: admin/password)
### Testing ### Testing
@@ -167,9 +167,9 @@ This template includes functionality that allows users to choose where they want
1. In the Plugins list, find your plugin 1. In the Plugins list, find your plugin
2. Click the "Update Source" link next to the plugin 2. Click the "Update Source" link next to the plugin
3. Select your preferred update source: 3. Select your preferred update source:
- **WordPress.org**: Updates from the official WordPress.org repository * **WordPress.org**: Updates from the official WordPress.org repository
- **GitHub**: Updates directly from the GitHub repo * **GitHub**: Updates directly from the GitHub repo
- **Gitea**: Updates directly from the Gitea repo * **Gitea**: Updates directly from the Gitea repo
4. Click "Save" to apply your preference 4. Click "Save" to apply your preference
## Frequently Asked Questions ## Frequently Asked Questions
@@ -181,6 +181,7 @@ See the [Starter Prompt](.wiki/Starter-Prompt.md) file for detailed instructions
### What files do I need to update with my plugin information? ### What files do I need to update with my plugin information?
The main files you need to update include: The main files you need to update include:
1. Main plugin file (rename and update header) 1. Main plugin file (rename and update header)
2. README.md 2. README.md
3. readme.txt 3. readme.txt
@@ -240,16 +241,16 @@ Contributions are welcome! Please feel free to submit a Pull Request.
This repository is configured to work with various AI-powered development tools. You can use any of the following AI IDEs to contribute to this project: This repository is configured to work with various AI-powered development tools. You can use any of the following AI IDEs to contribute to this project:
- [Augment Code](https://www.augmentcode.com/) - AI-powered coding assistant * [Augment Code](https://www.augmentcode.com/) - AI-powered coding assistant
- [Bolt](https://www.bolt.new/) - AI-powered code editor * [Bolt](https://www.bolt.new/) - AI-powered code editor
- [Cline](https://cline.bot/) - AI terminal assistant * [Cline](https://cline.bot/) - AI terminal assistant
- [Cody](https://sourcegraph.com/cody) - Sourcegraph's AI coding assistant * [Cody](https://sourcegraph.com/cody) - Sourcegraph's AI coding assistant
- [Continue](https://continue.dev/) - Open-source AI coding assistant * [Continue](https://continue.dev/) - Open-source AI coding assistant
- [Cursor](https://cursor.com/) - AI-first code editor * [Cursor](https://cursor.com/) - AI-first code editor
- [Loveable](https://lovable.dev/) - AI development environment * [Loveable](https://lovable.dev/) - AI development environment
- [Roo Code](https://roocode.com/) - AI pair programmer * [Roo Code](https://roocode.com/) - AI pair programmer
- [v0](https://v0.dev/) - AI-powered design and development tool * [v0](https://v0.dev/) - AI-powered design and development tool
- [Windsurf](https://www.windsurf.com/) - AI coding assistant * [Windsurf](https://www.windsurf.com/) - AI coding assistant
The repository includes configuration files for all these tools to ensure a consistent development experience. The repository includes configuration files for all these tools to ensure a consistent development experience.
@@ -278,25 +279,37 @@ For more information on Git Updater integration, see the [Git Updater Required H
## Changelog ## Changelog
### 0.1.10
* Fixed: Formatting issues in markdown files for better code quality
* Fixed: Improved URL formatting with angle brackets
* Fixed: Standardized list formatting across documentation files
### 0.1.9 ### 0.1.9
* Changed: Alphabetized AI IDE list. * Changed: Alphabetized AI IDE list.
### 0.1.8 ### 0.1.8
* Added: More informative badges (Build Status, Requirements, WP.org placeholders, Release, Issues, Contributors, Wiki). * Added: More informative badges (Build Status, Requirements, WP.org placeholders, Release, Issues, Contributors, Wiki).
### 0.1.7 ### 0.1.7
* Fixed: GitHub Actions tests workflow with proper file paths and dependencies * Fixed: GitHub Actions tests workflow with proper file paths and dependencies
### 0.1.6 ### 0.1.6
* Fixed: GitHub Actions workflows permissions for releases and wiki sync * Fixed: GitHub Actions workflows permissions for releases and wiki sync
### 0.1.5 ### 0.1.5
* Fixed: Release workflow to use correct plugin directory name * Fixed: Release workflow to use correct plugin directory name
* Added: Testing setup with wp-env and Cypress * Added: Testing setup with wp-env and Cypress
* Added: Multisite compatibility * Added: Multisite compatibility
* Added: npm scripts for development and testing * Added: npm scripts for development and testing
### 0.1.3 ### 0.1.3
* Added: Improved AI IDE context recommendations in documentation * Added: Improved AI IDE context recommendations in documentation
* Enhanced: Starter Prompt with guidance on pinning .ai-assistant.md and .ai-workflows/ * Enhanced: Starter Prompt with guidance on pinning .ai-assistant.md and .ai-workflows/
* Moved: Starter Prompt to the wiki for better organization * Moved: Starter Prompt to the wiki for better organization
@@ -304,14 +317,17 @@ For more information on Git Updater integration, see the [Git Updater Required H
* Improved: Documentation for AI-assisted development * Improved: Documentation for AI-assisted development
### 0.1.2 ### 0.1.2
* Added: STARTER-PROMPT.md with comprehensive guide for customizing the template * Added: STARTER-PROMPT.md with comprehensive guide for customizing the template
* Updated: Documentation files with improved instructions * Updated: Documentation files with improved instructions
* Added: Additional AI workflow files for better development guidance * Added: Additional AI workflow files for better development guidance
### 0.1.1 ### 0.1.1
* Updated: LICENSE file with correct GPL-2.0 text * Updated: LICENSE file with correct GPL-2.0 text
### 0.1.0 ### 0.1.0
* Initial release with basic template structure * Initial release with basic template structure
* Added: Core plugin architecture with OOP approach * Added: Core plugin architecture with OOP approach
* Added: Admin interface components and styling * Added: Admin interface components and styling

2
composer.json
View File

@@ -2,7 +2,7 @@
"name": "wpallstars/wp-plugin-starter-template-for-ai-coding", "name": "wpallstars/wp-plugin-starter-template-for-ai-coding",
"description": "A starter template for WordPress plugins with AI development workflows.", "description": "A starter template for WordPress plugins with AI development workflows.",
"type": "wordpress-plugin", "type": "wordpress-plugin",
"version": "0.1.9", "version": "0.1.10",
"license": "GPL-2.0-or-later", "license": "GPL-2.0-or-later",
"authors": [ "authors": [
{ {

2
package.json
View File

@@ -1,6 +1,6 @@
{ {
"name": "wp-plugin-starter-template-for-ai-coding", "name": "wp-plugin-starter-template-for-ai-coding",
"version": "0.1.9", "version": "0.1.10",
"description": "A comprehensive starter template for WordPress plugins with best practices for AI-assisted development.", "description": "A comprehensive starter template for WordPress plugins with best practices for AI-assisted development.",
"main": "index.js", "main": "index.js",
"scripts": { "scripts": {

10
readme.txt
View File

@@ -5,7 +5,7 @@ Tags: starter, template, boilerplate, plugin development, ai coding
Requires at least: 5.0 Requires at least: 5.0
Tested up to: 6.5 Tested up to: 6.5
Requires PHP: 7.4 Requires PHP: 7.4
Stable tag: 0.1.9 Stable tag: 0.1.10
License: GPL-2.0-or-later License: GPL-2.0-or-later
License URI: https://www.gnu.org/licenses/gpl-2.0.html License URI: https://www.gnu.org/licenses/gpl-2.0.html
@@ -205,6 +205,11 @@ npm run multisite
== Changelog == == Changelog ==
= 0.1.10 =
* Fixed: Formatting issues in markdown files for better code quality
* Fixed: Improved URL formatting with angle brackets
* Fixed: Standardized list formatting across documentation files
= 0.1.9 = = 0.1.9 =
* Changed: Alphabetized AI IDE list in README.md * Changed: Alphabetized AI IDE list in README.md
@@ -251,6 +256,9 @@ npm run multisite
== Upgrade Notice == == Upgrade Notice ==
= 0.1.10 =
Improved code quality with better formatting in documentation files, standardized list formatting, and proper URL formatting.
= 0.1.9 = = 0.1.9 =
Alphabetized the list of recommended AI IDEs in README.md for better readability. Alphabetized the list of recommended AI IDEs in README.md for better readability.

22
wiki/Changelog.md
View File

@@ -3,57 +3,79 @@
All notable changes to this project should be documented both here and in the main Readme files. All notable changes to this project should be documented both here and in the main Readme files.
#### [0.1.9] - 2025-04-18 #### [0.1.9] - 2025-04-18
#### Changed #### Changed
- Alphabetized AI IDE list in README.md - Alphabetized AI IDE list in README.md
#### [0.1.8] - 2025-04-19 #### [0.1.8] - 2025-04-19
#### Added #### Added
- More informative badges to README.md (Build Status, Requirements, WP.org placeholders, Release, Issues, Contributors, Wiki). - More informative badges to README.md (Build Status, Requirements, WP.org placeholders, Release, Issues, Contributors, Wiki).
#### [0.1.7] - 2025-04-19 #### [0.1.7] - 2025-04-19
#### Fixed #### Fixed
- GitHub Actions tests workflow with proper file paths and dependencies - GitHub Actions tests workflow with proper file paths and dependencies
#### Improved #### Improved
- Workflow names for better clarity in GitHub Actions UI - Workflow names for better clarity in GitHub Actions UI
#### [0.1.6] - 2025-04-19 #### [0.1.6] - 2025-04-19
#### Fixed #### Fixed
- GitHub Actions workflows permissions for releases and wiki sync - GitHub Actions workflows permissions for releases and wiki sync
#### [0.1.5] - 2025-04-19 #### [0.1.5] - 2025-04-19
#### Fixed #### Fixed
- Release workflow to use correct plugin directory name - Release workflow to use correct plugin directory name
#### Added #### Added
- Testing setup with wp-env and Cypress - Testing setup with wp-env and Cypress
- Multisite compatibility - Multisite compatibility
- npm scripts for development and testing - npm scripts for development and testing
#### [0.1.3] - 2025-04-19 #### [0.1.3] - 2025-04-19
#### Added #### Added
- Improved AI IDE context recommendations in documentation - Improved AI IDE context recommendations in documentation
- Enhanced Starter Prompt with guidance on pinning .ai-assistant.md and .ai-workflows/ - Enhanced Starter Prompt with guidance on pinning .ai-assistant.md and .ai-workflows/
#### Changed #### Changed
- Updated README.md and readme.txt with AI IDE context recommendations - Updated README.md and readme.txt with AI IDE context recommendations
- Improved documentation for AI-assisted development - Improved documentation for AI-assisted development
- Moved Starter Prompt to the wiki for better organization - Moved Starter Prompt to the wiki for better organization
#### [0.1.2] - 2025-04-18 #### [0.1.2] - 2025-04-18
#### Added #### Added
- STARTER-PROMPT.md with comprehensive guide for customizing the template - STARTER-PROMPT.md with comprehensive guide for customizing the template
- Additional AI workflow files for better development guidance - Additional AI workflow files for better development guidance
#### Changed #### Changed
- Updated documentation files with improved instructions - Updated documentation files with improved instructions
#### [0.1.1] - 2025-04-18 #### [0.1.1] - 2025-04-18
#### Changed #### Changed
- Updated LICENSE file with correct GPL-2.0 text - Updated LICENSE file with correct GPL-2.0 text
#### [0.1.0] - 2025-04-17 #### [0.1.0] - 2025-04-17
#### Added #### Added
- Initial release with basic template structure - Initial release with basic template structure
- Core plugin architecture with OOP approach - Core plugin architecture with OOP approach
- Admin interface components and styling - Admin interface components and styling

1
wiki/Frequently-Asked-Questions.md
View File

@@ -11,6 +11,7 @@ The WordPress Plugin Starter Template is a comprehensive starting point for deve
### Who is this template for? ### Who is this template for?
This template is designed for: This template is designed for:
- WordPress plugin developers looking for a solid foundation - WordPress plugin developers looking for a solid foundation
- Developers who want to leverage AI assistance in their development workflow - Developers who want to leverage AI assistance in their development workflow
- Anyone who wants to create a WordPress plugin following best practices - Anyone who wants to create a WordPress plugin following best practices

4
wiki/_Sidebar.md
View File

@@ -1,4 +1,5 @@
## User Documentation ## User Documentation
* [Home](Home) * [Home](Home)
* [Installation Guide](Installation-Guide) * [Installation Guide](Installation-Guide)
* [Usage Instructions](Usage-Instructions) * [Usage Instructions](Usage-Instructions)
@@ -6,6 +7,7 @@
* [Troubleshooting](Troubleshooting) * [Troubleshooting](Troubleshooting)
## Developer Documentation ## Developer Documentation
* [Architecture Overview](Architecture-Overview) * [Architecture Overview](Architecture-Overview)
* [Customization Guide](Customization-Guide) * [Customization Guide](Customization-Guide)
* [Extending the Plugin](Extending-the-Plugin) * [Extending the Plugin](Extending-the-Plugin)
@@ -13,8 +15,10 @@
* [Release Process](Release-Process) * [Release Process](Release-Process)
## AI Documentation ## AI Documentation
* [AI Workflow Documentation](AI-Workflow-Documentation) * [AI Workflow Documentation](AI-Workflow-Documentation)
## Additional Resources ## Additional Resources
* [Changelog](Changelog) * [Changelog](Changelog)
* [Contributing](Contributing) * [Contributing](Contributing)

4
wp-plugin-starter-template.php
View File

@@ -3,7 +3,7 @@
* Plugin Name: WordPress Plugin Starter Template * Plugin Name: WordPress Plugin Starter Template
* Plugin URI: https://www.wpallstars.com * Plugin URI: https://www.wpallstars.com
* Description: A comprehensive starter template for WordPress plugins with best practices for AI-assisted development. * Description: A comprehensive starter template for WordPress plugins with best practices for AI-assisted development.
* Version: 0.1.9 * Version: 0.1.10
* Author: Your Name & The WPALLSTARS Team * Author: Your Name & The WPALLSTARS Team
* Author URI: https://www.wpallstars.com * Author URI: https://www.wpallstars.com
* License: GPL-2.0+ * License: GPL-2.0+
@@ -35,4 +35,4 @@ if ( ! defined( 'WPINC' ) ) {
require_once plugin_dir_path( __FILE__ ) . 'includes/class-plugin.php'; require_once plugin_dir_path( __FILE__ ) . 'includes/class-plugin.php';
// Initialize the plugin. // Initialize the plugin.
new WPALLSTARS\PluginStarterTemplate\Plugin( __FILE__, '0.1.9' ); new WPALLSTARS\PluginStarterTemplate\Plugin( __FILE__, '0.1.10' );