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

Fixed formatting issues in markdown documentation files

Browse Source
This commit is contained in:
Marcus Quinn
2025-04-19 21:52:28 +01:00
parent c930a5484a
commit a885ef1e0b
12 changed files with 83 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -62,6 +62,7 @@ When reviewing code, check for the following:
### 1. Understand the Context
Before reviewing code, understand:
- What problem is the code trying to solve?
- What are the requirements?
- What are the constraints?
@@ -73,6 +74,7 @@ Review the code with the checklist above in mind.
### 3. Provide Feedback
When providing feedback:
- Be specific and clear
- Explain why a change is needed
- Provide examples or suggestions when possible
@@ -82,6 +84,7 @@ When providing feedback:
### 4. Follow Up
After the code has been updated:
- Review the changes
- Verify that issues have been addressed
- Provide additional feedback if necessary
@@ -128,7 +131,7 @@ After the code has been updated:
```
In function `handle_remove_reference()`:
1. The nonce check is missing, which could lead to CSRF vulnerabilities.
1. The nonce check is missing, which could lead to CSRF vulnerabilities.
Consider adding:
```php
if (!isset($_GET['_wpnonce']) || !wp_verify_nonce($_GET['_wpnonce'], 'fpden_remove_reference')) {
@@ -150,7 +153,7 @@ In function `handle_remove_reference()`:
```php
// Change this:
add_settings_error('fpden', 'fpden_removed', 'Plugin reference removed successfully.', 'updated');
// To this:
add_settings_error('fpden', 'fpden_removed', __('Plugin reference removed successfully.', 'fix-plugin-does-not-exist-notices'), 'updated');
```

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
When the user confirms that changes are working correctly:
1. Create a version branch and update version numbers
2. Tag the version branch as stable
```bash
@@ -62,6 +63,7 @@ git checkout -b fix/plugin-activation-error
### 2. Make Changes Without Updating Version Numbers
During the development and testing phase:
- Implement the necessary changes
- **Don't update version numbers** in any files yet
- Focus on the functionality
@@ -79,6 +81,7 @@ CURRENT_VERSION=$(grep -o "Version: [0-9.]*" wp-fix-plugin-does-not-exist-notice
```
This will:
1. Create a build directory
2. Copy required files to the build directory
3. Deploy the plugin to your local WordPress testing environment
@@ -88,6 +91,7 @@ This will:
### 4. Test and Evaluate
Test the changes thoroughly in the local environment:
- Verify that the specific issue is fixed or feature works as expected
- Check for any regressions or new issues
- 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.
## Repository Paths
- 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 configuration: ~/Local/plugin-testing/conf/
## URLs
- LocalWP plugin testing URL: http://plugin-testing.local/
- PHP details: http://plugin-testing.local/local-phpinfo.php
- XDebug info: http://plugin-testing.local/local-xdebuginfo.php
- Adminer Evo: http://localhost:10010/?username=root&db=local
- Mailpit: http://localhost:10000/
- LocalWP plugin testing URL: <http://plugin-testing.local/>
- PHP details: <http://plugin-testing.local/local-phpinfo.php>
- XDebug info: <http://plugin-testing.local/local-xdebuginfo.php>
- Adminer Evo: <http://localhost:10010/?username=root&db=local>
- Mailpit: <http://localhost:10000/>
## Build and Deploy Scripts
- 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

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
**ALWAYS** verify which repository you're currently working in before:
- Making code suggestions
- Creating or updating documentation
- Discussing features or functionality
@@ -44,6 +45,7 @@ Suggesting changes or improvements based on other repositories, leading to scope
### 2. Explicit Code Search Scoping
When searching for code or functionality:
- Explicitly limit searches to the current repository
- Use repository-specific paths in search queries
- 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:
- Create a clean build in the `build/` directory
- Generate a ZIP file for distribution
- Deploy to a local WordPress installation if configured
Test the plugin thoroughly:
- Test with the latest WordPress version
- Test with the minimum supported WordPress version (5.0)
- Test with PHP 7.0+ (minimum supported version)
@@ -139,6 +141,7 @@ Follow semantic versioning (MAJOR.MINOR.PATCH):
- **PATCH**: Backward-compatible bug fixes
Examples:
- Bug fix: 1.0.0 → 1.0.1
- New feature: 1.0.0 → 1.1.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.
## Version 0.1.6 (2025-04-19)
### Fixed
- GitHub Actions workflows permissions for releases and wiki sync
## Version 0.1.5 (2025-04-19)
### Fixed
- Release workflow to use correct plugin directory name
### Added
- Testing setup with wp-env and Cypress
- Multisite compatibility
- npm scripts for development and testing
## Version 0.1.3 (2025-04-19)
### Added
- Improved AI IDE context recommendations in documentation
- Enhanced Starter Prompt with guidance on pinning .ai-assistant.md and .ai-workflows/
### Changed
- Updated README.md and readme.txt with AI IDE context recommendations
- Improved documentation for AI-assisted development
- Moved Starter Prompt to the wiki for better organization
## Version 0.1.2 (2025-04-18)
### Added
- STARTER-PROMPT.md with comprehensive guide for customizing the template
- Additional AI workflow files for better development guidance
### Changed
- Updated documentation files with improved instructions
## Version 0.1.1 (2025-04-18)
### Changed
- Updated LICENSE file with correct GPL-2.0 text
## Version 0.1.0 (2025-04-17)
### Added
- Initial release with basic template structure
- Core plugin architecture with OOP approach
- 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?
This template is designed for:
- WordPress plugin developers looking for a solid foundation
- Developers who want to leverage AI assistance in their development workflow
- 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.
**Solutions**:
1. Verify that your WordPress version meets the minimum requirement (5.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
@@ -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.
**Solutions**:
1. Check the error message for specific details
2. Verify that all plugin dependencies are installed and activated
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.
**Solutions**:
1. Verify that you have Composer installed and up to date
2. Check that your PHP version meets the requirements for all dependencies
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.
**Solutions**:
1. Verify that you have Node.js and NPM installed and up to date
2. Try clearing NPM's cache: `npm cache clean --force`
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.
**Solutions**:
1. Verify that Docker is installed and running
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`
@@ -61,6 +66,7 @@ This guide provides solutions to common issues you might encounter when using or
**Problem**: Unit tests are failing.
**Solutions**:
1. Verify that you have PHPUnit installed and configured correctly
2. Check that all dependencies are installed: `composer install`
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.
**Solutions**:
1. Verify that the WordPress environment is running: `npm run start`
2. Check that Cypress is installed correctly: `npx cypress verify`
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.
**Solutions**:
1. Check for JavaScript errors in the browser console
2. Verify that the settings form is submitting 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.
**Solutions**:
1. Deactivate other plugins one by one to identify the conflict
2. Check for JavaScript errors in the browser console
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.
**Solutions**:
1. Check if the plugin is making excessive database queries
2. Verify that assets (CSS/JS) are being properly enqueued and minified
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.
**Solutions**:
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
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.
**Solutions**:
1. Check if the plugin includes a data migration process for updates
2. Verify that the settings are being stored in the database correctly
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.
**Solutions**:
1. Verify that the plugin is network activated if required
2. Check that the plugin is compatible with multisite (it should be!)
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
Please include:
- A clear description of the bug
- Steps to reproduce the issue
- Your environment details (WordPress version, PHP version, etc.)

4
.wiki/_Sidebar.md
View File

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

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.
#### [0.1.9] - 2025-04-18
#### Changed
- Alphabetized AI IDE list in README.md
#### [0.1.8] - 2025-04-19
#### Added
- More informative badges to README.md (Build Status, Requirements, WP.org placeholders, Release, Issues, Contributors, Wiki).
#### [0.1.7] - 2025-04-19
#### Fixed
- GitHub Actions tests workflow with proper file paths and dependencies
#### Improved
- Workflow names for better clarity in GitHub Actions UI
#### [0.1.6] - 2025-04-19
#### Fixed
- GitHub Actions workflows permissions for releases and wiki sync
#### [0.1.5] - 2025-04-19
#### Fixed
- Release workflow to use correct plugin directory name
#### Added
- Testing setup with wp-env and Cypress
- Multisite compatibility
- npm scripts for development and testing
#### [0.1.3] - 2025-04-19
#### Added
- Improved AI IDE context recommendations in documentation
- Enhanced Starter Prompt with guidance on pinning .ai-assistant.md and .ai-workflows/
#### Changed
- Updated README.md and readme.txt with AI IDE context recommendations
- Improved documentation for AI-assisted development
- Moved Starter Prompt to the wiki for better organization
#### [0.1.2] - 2025-04-18
#### Added
- STARTER-PROMPT.md with comprehensive guide for customizing the template
- Additional AI workflow files for better development guidance
#### Changed
- Updated documentation files with improved instructions
#### [0.1.1] - 2025-04-18
#### Changed
- Updated LICENSE file with correct GPL-2.0 text
#### [0.1.0] - 2025-04-17
#### Added
- Initial release with basic template structure
- Core plugin architecture with OOP approach
- 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?
This template is designed for:
- WordPress plugin developers looking for a solid foundation
- Developers who want to leverage AI assistance in their development workflow
- Anyone who wants to create a WordPress plugin following best practices

4
wiki/_Sidebar.md
View File

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