Merge main into feature/testing-framework
Resolved conflicts: - package.json: Use version 0.1.15 from main - wp-plugin-starter-template.php: Use version 0.1.15, keep Plugin class usage - AGENTS.md: Merge both versions, keep CI/CD content - .wiki/Architecture-Overview.md: Use .agents/ directory structure - wiki/* files: Delete (moved to .wiki/) - .agents/error-checking-feedback-loops.md: Keep from feature branch Also includes: - Renamed .ai-workflows/ to .agents/ - Renamed .ai-assistant.md to AGENTS.md - Updated version to 0.1.15
This commit is contained in:
@@ -16,7 +16,7 @@ git checkout -b fix/bug-description
|
||||
|
||||
Use a descriptive name that clearly indicates what bug is being fixed. If there's an issue number, include it in the branch name (e.g., `fix/123-plugin-activation-error`).
|
||||
|
||||
For more detailed git workflow guidelines, see **@.ai-workflows/git-workflow.md**.
|
||||
For more detailed git workflow guidelines, see **@.agents/git-workflow.md**.
|
||||
|
||||
### 2. Understand the Bug
|
||||
|
||||
@@ -111,7 +111,7 @@ After fixing a bug and confirming it works, determine the appropriate version in
|
||||
|
||||
This approach is more time-efficient as it allows you to focus on fixing the bug without worrying about version updates until the fix is confirmed working.
|
||||
|
||||
For detailed guidelines on time-efficient development and testing, see **@.ai-workflows/incremental-development.md**.
|
||||
For detailed guidelines on time-efficient development and testing, see **@.agents/incremental-development.md**.
|
||||
|
||||
## Testing Previous Versions
|
||||
|
||||
@@ -147,7 +147,7 @@ I ran PHPCS and got the following errors. Can you help me fix them?
|
||||
[Paste error output here]
|
||||
```
|
||||
|
||||
For more AI assistance guidelines, see the [AI Assistant Guide](./../.ai-assistant.md).
|
||||
For more AI assistance guidelines, see the [AI Assistant Guide](./../AGENTS.md).
|
||||
|
||||
## Conclusion
|
||||
|
||||
@@ -31,9 +31,9 @@ This document serves as a persistent memory for developer preferences establishe
|
||||
|
||||
### Documentation
|
||||
|
||||
- Prefer token-efficient documentation in `.ai-assistant.md` that references `.ai-workflows/` files
|
||||
- Document the release workflow in `.ai-assistant.md` and `.ai-workflows/release-process.md`
|
||||
- Store environment variable documentation in `.ai-workflows/local-env-vars.md`
|
||||
- Prefer token-efficient documentation in `AGENTS.md` that references `.agents/` files
|
||||
- Document the release workflow in `AGENTS.md` and `.agents/release-process.md`
|
||||
- Store environment variable documentation in `.agents/local-env-vars.md`
|
||||
- Maintain consistent documentation across readme.txt, README.md, and CHANGELOG.md
|
||||
|
||||
### Asset Organization
|
||||
@@ -16,7 +16,7 @@ git checkout -b feature/descriptive-name
|
||||
|
||||
Use a descriptive name that clearly indicates what the feature is about. If there's an issue number, include it in the branch name (e.g., `feature/123-update-source-selector`).
|
||||
|
||||
For more detailed git workflow guidelines, see **@.ai-workflows/git-workflow.md**.
|
||||
For more detailed git workflow guidelines, see **@.agents/git-workflow.md**.
|
||||
|
||||
### 2. Implement the Feature
|
||||
|
||||
@@ -44,7 +44,7 @@ Update relevant documentation to reflect the new feature:
|
||||
- Add screenshots or examples if applicable
|
||||
- Remember that any feature addition will require a version increment in all relevant files
|
||||
|
||||
For detailed guidelines on maintaining wiki documentation, see **@.ai-workflows/wiki-documentation.md**.
|
||||
For detailed guidelines on maintaining wiki documentation, see **@.agents/wiki-documentation.md**.
|
||||
|
||||
### 4. Testing
|
||||
|
||||
@@ -100,7 +100,7 @@ git tag -a v{MAJOR}.{MINOR+1}.0-stable -m "Stable version {MAJOR}.{MINOR+1}.0"
|
||||
|
||||
**IMPORTANT**: Don't update version numbers during initial development and testing. Only create a version branch and update version numbers when the feature is confirmed working.
|
||||
|
||||
For detailed guidelines on time-efficient development and testing, see **@.ai-workflows/incremental-development.md**.
|
||||
For detailed guidelines on time-efficient development and testing, see **@.agents/incremental-development.md**.
|
||||
|
||||
### 7. Push to Remote (Optional for Collaboration)
|
||||
|
||||
@@ -173,7 +173,7 @@ When developing features in a workspace with multiple repositories:
|
||||
- Adapt the feature to fit the current repository's needs and architecture
|
||||
- Document the inspiration source in code comments
|
||||
|
||||
For detailed guidelines on working in multi-repository workspaces, see **@.ai-workflows/multi-repo-workspace.md**.
|
||||
For detailed guidelines on working in multi-repository workspaces, see **@.agents/multi-repo-workspace.md**.
|
||||
|
||||
## Feature Types and Implementation Guidelines
|
||||
|
||||
@@ -8,7 +8,7 @@ This document outlines the folder structure of the plugin and explains the purpo
|
||||
- **includes/** - Contains core plugin functionality and classes
|
||||
- **languages/** - Contains translation files
|
||||
- **scripts/** - Contains build and deployment scripts
|
||||
- **.ai-workflows/** - Contains documentation for AI assistants
|
||||
- **.agents/** - Contains documentation for AI assistants
|
||||
- **.github/** - Contains GitHub-specific files like workflows
|
||||
- **.wordpress-org/** - Contains WordPress.org assets like banners and screenshots
|
||||
|
||||
@@ -186,7 +186,7 @@ When preparing for a release:
|
||||
- Update version numbers
|
||||
- Update changelogs
|
||||
- Create tag
|
||||
- See **@.ai-workflows/release-process.md** for complete details
|
||||
- See **@.agents/release-process.md** for complete details
|
||||
|
||||
## Contributing to External Repositories
|
||||
|
||||
@@ -233,7 +233,7 @@ Monitor the PR for feedback from maintainers and be prepared to make additional
|
||||
- Review code thoroughly before approving
|
||||
- Test changes locally when possible
|
||||
- Provide constructive feedback
|
||||
- See **@.ai-workflows/code-review.md** for detailed code review guidelines
|
||||
- See **@.agents/code-review.md** for detailed code review guidelines
|
||||
|
||||
### Suggested Improvements
|
||||
|
||||
@@ -127,7 +127,7 @@ When working in a multi-repository workspace, it's critical to ensure that wiki
|
||||
- If referencing functionality from another repository, clearly indicate that it's external
|
||||
- Use phrases like "unlike Repository X, this plugin does not include..."
|
||||
|
||||
For detailed guidelines on working in multi-repository workspaces, see **@.ai-workflows/multi-repo-workspace.md**.
|
||||
For detailed guidelines on working in multi-repository workspaces, see **@.agents/multi-repo-workspace.md**.
|
||||
|
||||
## Best Practices
|
||||
|
||||
@@ -12,8 +12,8 @@ AI-assisted development uses artificial intelligence tools to help with coding,
|
||||
|
||||
To get the most out of AI-assisted development, make sure to include these files in your AI IDE context:
|
||||
|
||||
1. **.ai-assistant.md**: Contains essential information about the project structure and conventions
|
||||
2. **.ai-workflows/**: Directory containing detailed workflow documentation for common tasks
|
||||
1. **AGENTS.md**: Contains essential information about the project structure and conventions
|
||||
2. **.agents/**: Directory containing detailed workflow documentation for common tasks
|
||||
|
||||
### Pinning Files in AI IDEs
|
||||
|
||||
@@ -26,7 +26,7 @@ For the best results, pin these files in your AI IDE chat context:
|
||||
|
||||
## AI Workflow Files
|
||||
|
||||
The `.ai-workflows/` directory contains detailed guides for common development tasks:
|
||||
The `.agents/` directory contains detailed guides for common development tasks:
|
||||
|
||||
1. **plugin-customization.md**: Guide for customizing the plugin for specific needs
|
||||
2. **feature-development.md**: Workflow for developing new features
|
||||
@@ -50,7 +50,7 @@ The [Starter Prompt](Starter-Prompt) is a comprehensive guide for AI tools to he
|
||||
|
||||
### Customizing the Plugin
|
||||
|
||||
1. Open your AI IDE and pin the `.ai-assistant.md` file and `.ai-workflows/` directory
|
||||
1. Open your AI IDE and pin the `AGENTS.md` file and `.agents/` directory
|
||||
2. Provide the Starter Prompt to the AI
|
||||
3. Follow the AI's guidance to customize the plugin
|
||||
4. Review and test the changes
|
||||
|
||||
@@ -30,10 +30,7 @@ wp-plugin-starter-template/
|
||||
│ └── setup-test-env.sh # Test environment setup script
|
||||
├── .github/ # GitHub-specific files
|
||||
│ └── workflows/ # GitHub Actions workflows
|
||||
├── .wp-env.json # WordPress environment config
|
||||
├── .wp-env.multisite.json # Multisite environment config
|
||||
├── cypress.config.js # Cypress configuration
|
||||
├── .ai-workflows/ # AI workflow documentation
|
||||
├── .agents/ # AI workflow documentation
|
||||
├── .wiki/ # Wiki documentation
|
||||
│ ├── Testing-Framework.md # Testing framework documentation
|
||||
│ └── Multisite-Development.md # Multisite development guide
|
||||
|
||||
@@ -25,7 +25,7 @@ This page documents all notable changes to the WordPress Plugin Starter Template
|
||||
### 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 AGENTS.md and .agents/
|
||||
|
||||
### Changed
|
||||
|
||||
|
||||
@@ -80,8 +80,8 @@ To configure the update mechanism:
|
||||
|
||||
The template includes:
|
||||
|
||||
1. Detailed documentation in the `.ai-assistant.md` file
|
||||
2. Workflow guidelines in the `.ai-workflows/` directory
|
||||
1. Detailed documentation in the `AGENTS.md` file
|
||||
2. Workflow guidelines in the `.agents/` directory
|
||||
3. Clear code structure and comments that help AI understand the codebase
|
||||
4. Best practices for AI-friendly code organization
|
||||
|
||||
@@ -96,7 +96,7 @@ This template is designed to work well with various AI coding assistants, includ
|
||||
|
||||
### How do I use the AI workflow documentation?
|
||||
|
||||
The AI workflow documentation in the `.ai-workflows/` directory provides guidelines for AI assistants working with this template. These files help ensure consistent, high-quality code and documentation when using AI tools for development.
|
||||
The AI workflow documentation in the `.agents/` directory provides guidelines for AI assistants working with this template. These files help ensure consistent, high-quality code and documentation when using AI tools for development.
|
||||
|
||||
## Contributing Questions
|
||||
|
||||
|
||||
@@ -39,7 +39,7 @@ This template is based on the experience gained from developing the "Fix 'Plugin
|
||||
|
||||
To get started with this template, check out the [Starter Prompt](Starter-Prompt) for a comprehensive guide on customizing the template for your specific plugin needs.
|
||||
|
||||
**Important**: For the best AI assistance, add the .ai-assistant.md file and .ai-workflows/ directory to your AI IDE chat context. In most AI IDEs, you can pin these files to ensure they're considered in each message.
|
||||
**Important**: For the best AI assistance, add the AGENTS.md file and .agents/ directory to your AI IDE chat context. In most AI IDEs, you can pin these files to ensure they're considered in each message.
|
||||
|
||||
## Support
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@ This document provides a comprehensive prompt to help you get started with creat
|
||||
|
||||
## Important: Optimize AI Context
|
||||
|
||||
**Before starting, add the .ai-assistant.md file and .ai-workflows/ directory to your AI IDE chat context.** In most AI IDEs, you can pin these files to ensure they're considered in each message. This will help the AI understand the project structure and follow the established best practices.
|
||||
**Before starting, add the AGENTS.md file and .agents/ directory to your AI IDE chat context.** In most AI IDEs, you can pin these files to ensure they're considered in each message. This will help the AI understand the project structure and follow the established best practices.
|
||||
|
||||
## Initial Setup Prompt
|
||||
|
||||
@@ -35,7 +35,7 @@ I need help with the following tasks:
|
||||
2. Customizing the plugin structure for my specific needs
|
||||
3. Setting up the initial functionality for my plugin
|
||||
|
||||
I've added the .ai-assistant.md and .ai-workflows/ directory to the chat context to ensure you have all the necessary information about the project structure and best practices.
|
||||
I've added the AGENTS.md and .agents/ directory to the chat context to ensure you have all the necessary information about the project structure and best practices.
|
||||
|
||||
Please guide me through this process step by step, starting with identifying all files that need to be updated with my plugin information.
|
||||
```
|
||||
@@ -52,7 +52,7 @@ The AI will help you identify and update the following files with your plugin in
|
||||
6. **languages/pot file**: Rename and update the POT file
|
||||
7. **.github/workflows/**: Update GitHub Actions workflows with your repository information
|
||||
8. **.wiki/**: Update wiki documentation with your plugin information
|
||||
9. **.ai-assistant.md**: Update AI assistant guidance for your specific plugin
|
||||
9. **AGENTS.md**: Update AI assistant guidance for your specific plugin
|
||||
10. **includes/plugin.php**: Update namespace and class references
|
||||
11. **includes/core.php**: Update namespace and customize core functionality
|
||||
12. **admin/lib/admin.php**: Update namespace and customize admin functionality
|
||||
@@ -174,7 +174,7 @@ Please guide me through the process of building and testing my plugin:
|
||||
To ensure the AI assistant has all the necessary context about your plugin's structure and best practices:
|
||||
|
||||
```
|
||||
Please add the .ai-assistant.md and .ai-workflows/ directory to your AI IDE chat context. In most AI IDEs, you can pin these files to ensure they're considered in each message. This will help the AI understand the project structure and follow the established best practices.
|
||||
Please add the AGENTS.md and .agents/ directory to your AI IDE chat context. In most AI IDEs, you can pin these files to ensure they're considered in each message. This will help the AI understand the project structure and follow the established best practices.
|
||||
```
|
||||
|
||||
## Remember
|
||||
@@ -183,7 +183,7 @@ Please add the .ai-assistant.md and .ai-workflows/ directory to your AI IDE chat
|
||||
- The AI assistant can help you understand the existing code and make appropriate modifications, but you should review all changes to ensure they meet your requirements.
|
||||
- Always test your plugin thoroughly before releasing it.
|
||||
- Keep documentation updated as you develop your plugin.
|
||||
- Pin the .ai-assistant.md and .ai-workflows/ files in your AI IDE chat to ensure the AI has the necessary context for each interaction.
|
||||
- Pin the AGENTS.md and .agents/ files in your AI IDE chat to ensure the AI has the necessary context for each interaction.
|
||||
|
||||
## Credits
|
||||
|
||||
|
||||
@@ -21,7 +21,7 @@ The template follows a modular structure:
|
||||
- `js/`: Admin JavaScript files
|
||||
- `languages/`: Translation files
|
||||
- `.github/workflows/`: GitHub Actions workflows
|
||||
- `.ai-workflows/`: Documentation for AI assistants
|
||||
- `.agents/`: Documentation for AI assistants
|
||||
- `.wiki/`: Wiki documentation templates
|
||||
|
||||
### Customizing for Your Plugin
|
||||
|
||||
@@ -16,9 +16,9 @@ This workspace may contain multiple repository folders. Always focus ONLY on the
|
||||
* **Plugin Slug**: wp-plugin-starter-template
|
||||
* **Text Domain**: wp-plugin-starter-template
|
||||
* **Namespace**: WPALLSTARS\PluginStarterTemplate
|
||||
* **Version**: 0.1.13
|
||||
* **Version**: 0.1.15
|
||||
* **Requires WordPress**: 5.0+
|
||||
* **Requires PHP**: 7.0+
|
||||
* **Requires PHP**: 7.4+
|
||||
* **License**: GPL-2.0+
|
||||
|
||||
## Repository Structure
|
||||
@@ -34,7 +34,7 @@ This workspace may contain multiple repository folders. Always focus ONLY on the
|
||||
* **js/**: Admin JavaScript files
|
||||
* **languages/**: Translation files
|
||||
* **.github/workflows/**: GitHub Actions workflows
|
||||
* **.ai-workflows/**: Documentation for AI assistants
|
||||
* **.agents/**: Documentation for AI assistants
|
||||
* **.wiki/**: Wiki documentation templates
|
||||
|
||||
## Coding Standards
|
||||
@@ -87,12 +87,7 @@ Always run PHPCS and PHPCBF locally before committing code to ensure it meets th
|
||||
|
||||
## Common Tasks
|
||||
|
||||
For detailed instructions on common tasks, refer to these workflow documents:
|
||||
|
||||
* **@.ai-workflows/release-process.md**: Creating releases, versioning, and deployment
|
||||
* **@.ai-workflows/feature-development.md**: Adding new features and functionality
|
||||
* **@.ai-workflows/bug-fixing.md**: Diagnosing and fixing issues
|
||||
* **@.ai-workflows/error-checking-feedback-loops.md**: Monitoring CI/CD pipelines and establishing feedback loops
|
||||
For detailed instructions on common tasks like creating releases, adding features, fixing bugs, and testing previous versions, see **@.agents/release-process.md**.
|
||||
|
||||
## Avoiding Cross-Repository Confusion
|
||||
|
||||
@@ -172,7 +167,7 @@ This repository is set up for autonomous continuous integration and deployment w
|
||||
4. **Verify Solutions**: Ensure fixes pass all tests and quality checks
|
||||
5. **Document Resolutions**: Update documentation with solutions for future reference
|
||||
|
||||
For detailed instructions on establishing feedback loops and error checking processes, see **@.ai-workflows/error-checking-feedback-loops.md**.
|
||||
For detailed instructions on establishing feedback loops and error checking processes, see **@.agents/error-checking-feedback-loops.md**.
|
||||
|
||||
### When to Consult Humans
|
||||
|
||||
16
CHANGELOG.md
16
CHANGELOG.md
@@ -1,5 +1,19 @@
|
||||
All notable changes to this project should be documented both here and in the main Readme files.
|
||||
|
||||
#### [0.1.15] - 2025-11-24
|
||||
|
||||
#### Release
|
||||
|
||||
- Maintenance release
|
||||
|
||||
#### [0.1.14] - 2025-11-24
|
||||
|
||||
#### Changed
|
||||
|
||||
- Renamed .ai-assistant.md to AGENTS.md
|
||||
- Renamed .ai-workflows directory to .agents
|
||||
- Updated all references in documentation and codebase
|
||||
|
||||
#### [0.1.13] - 2023-04-23
|
||||
|
||||
#### Improved
|
||||
@@ -89,7 +103,7 @@ All notable changes to this project should be documented both here and in the ma
|
||||
#### 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 AGENTS.md and .agents/
|
||||
|
||||
#### Changed
|
||||
|
||||
|
||||
18
README.md
18
README.md
@@ -26,7 +26,7 @@ This template is based on the experience gained from developing the "Fix 'Plugin
|
||||
|
||||
1. Clone or download this repository
|
||||
2. **Important**: Begin by reading the [Starter Prompt](.wiki/Starter-Prompt.md) file for detailed instructions
|
||||
3. Add the .ai-assistant.md file and .ai-workflows/ directory to your AI IDE chat context (pin them if possible)
|
||||
3. Add the AGENTS.md file and .agents/ directory to your AI IDE chat context (pin them if possible)
|
||||
4. Use the prompt in the Starter Prompt file to guide the AI in customizing the template for your plugin
|
||||
5. Rename files and update namespaces to match your plugin
|
||||
6. Customize the functionality for your specific needs
|
||||
@@ -37,17 +37,17 @@ This template is based on the experience gained from developing the "Fix 'Plugin
|
||||
|
||||
This template includes comprehensive documentation for AI-assisted development:
|
||||
|
||||
* **.ai-assistant.md**: Guide for AI assistants to understand the project structure
|
||||
* **.ai-workflows/**: Detailed workflow documentation for common development tasks
|
||||
* **AGENTS.md**: Guide for AI assistants to understand the project structure
|
||||
* **.agents/**: Detailed workflow documentation for common development tasks
|
||||
* **Starter Prompt**: Comprehensive prompt for AI tools to help customize the template (available in the [wiki](.wiki/Starter-Prompt.md))
|
||||
|
||||
**Important**: For the best AI assistance, add the .ai-assistant.md file and .ai-workflows/ directory to your AI IDE chat context. In most AI IDEs, you can pin these files to ensure they're considered in each message.
|
||||
**Important**: For the best AI assistance, add the AGENTS.md file and .agents/ directory to your AI IDE chat context. In most AI IDEs, you can pin these files to ensure they're considered in each message.
|
||||
|
||||
## Installation
|
||||
|
||||
1. Clone or download this repository
|
||||
2. Read the [Starter Prompt](.wiki/Starter-Prompt.md) file for detailed instructions
|
||||
3. Add the .ai-assistant.md file and .ai-workflows/ directory to your AI IDE chat context
|
||||
3. Add the AGENTS.md file and .agents/ directory to your AI IDE chat context
|
||||
4. Use the prompt in the Starter Prompt file to guide the AI in customizing the template
|
||||
5. Rename files and update namespaces to match your plugin
|
||||
6. Customize the functionality for your specific needs
|
||||
@@ -67,7 +67,7 @@ To get started with this template, follow these steps:
|
||||
|
||||
2. Open the [Starter Prompt](.wiki/Starter-Prompt.md) file and follow the instructions to customize the template for your plugin.
|
||||
|
||||
3. Add the .ai-assistant.md file and .ai-workflows/ directory to your AI IDE chat context.
|
||||
3. Add the AGENTS.md file and .agents/ directory to your AI IDE chat context.
|
||||
|
||||
4. Use an AI assistant like GitHub Copilot, Claude, or ChatGPT to help you customize the template by providing the prompt from the Starter Prompt file.
|
||||
|
||||
@@ -193,7 +193,7 @@ This template includes functionality that allows users to choose where they want
|
||||
|
||||
### How do I customize this template for my plugin?
|
||||
|
||||
See the [Starter Prompt](.wiki/Starter-Prompt.md) file for detailed instructions on customizing this template for your specific plugin needs. Make sure to add the .ai-assistant.md file and .ai-workflows/ directory to your AI IDE chat context for the best results.
|
||||
See the [Starter Prompt](.wiki/Starter-Prompt.md) file for detailed instructions on customizing this template for your specific plugin needs. Make sure to add the AGENTS.md file and .agents/ directory to your AI IDE chat context for the best results.
|
||||
|
||||
### What files do I need to update with my plugin information?
|
||||
|
||||
@@ -208,7 +208,7 @@ The main files you need to update include:
|
||||
7. languages/pot file
|
||||
8. .github/workflows/
|
||||
9. .wiki/
|
||||
10. .ai-assistant.md
|
||||
10. AGENTS.md
|
||||
11. includes/plugin.php
|
||||
12. includes/core.php
|
||||
13. admin/lib/admin.php
|
||||
@@ -562,7 +562,7 @@ For more information on Git Updater integration, see the [Git Updater Required H
|
||||
### 0.1.3
|
||||
|
||||
* 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 AGENTS.md and .agents/
|
||||
* Moved: Starter Prompt to the wiki for better organization
|
||||
* Updated: README.md and readme.txt with AI IDE context recommendations
|
||||
* Improved: Documentation for AI-assisted development
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
"name": "wpallstars/wp-plugin-starter-template-for-ai-coding",
|
||||
"description": "A starter template for WordPress plugins with AI development workflows.",
|
||||
"type": "wordpress-plugin",
|
||||
"version": "0.1.10",
|
||||
"version": "0.1.15",
|
||||
"license": "GPL-2.0-or-later",
|
||||
"authors": [
|
||||
{
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "wp-plugin-starter-template-for-ai-coding",
|
||||
"version": "0.1.13",
|
||||
"version": "0.1.15",
|
||||
"description": "A comprehensive starter template for WordPress plugins with best practices for AI-assisted development.",
|
||||
"main": "index.js",
|
||||
"scripts": {
|
||||
|
||||
34
readme.txt
34
readme.txt
@@ -5,7 +5,7 @@ Tags: starter, template, boilerplate, plugin development, ai coding
|
||||
Requires at least: 5.0
|
||||
Tested up to: 6.5
|
||||
Requires PHP: 7.4
|
||||
Stable tag: 0.1.13
|
||||
Stable tag: 0.1.15
|
||||
License: GPL-2.0-or-later
|
||||
License URI: https://www.gnu.org/licenses/gpl-2.0.html
|
||||
|
||||
@@ -33,7 +33,7 @@ This template is based on the experience gained from developing the "Fix 'Plugin
|
||||
|
||||
1. Clone or download this repository
|
||||
2. **Important**: Begin by reading the Starter Prompt file in the wiki for detailed instructions
|
||||
3. Add the .ai-assistant.md file and .ai-workflows/ directory to your AI IDE chat context (pin them if possible)
|
||||
3. Add the AGENTS.md file and .agents/ directory to your AI IDE chat context (pin them if possible)
|
||||
4. Use the prompt in the Starter Prompt file to guide the AI in customizing the template for your plugin
|
||||
5. Rename files and update namespaces to match your plugin
|
||||
6. Customize the functionality for your specific needs
|
||||
@@ -46,11 +46,11 @@ For detailed instructions, see the [Starter Prompt](https://github.com/wpallstar
|
||||
|
||||
This template includes comprehensive documentation for AI-assisted development:
|
||||
|
||||
* **.ai-assistant.md**: Guide for AI assistants to understand the project structure
|
||||
* **.ai-workflows/**: Detailed workflow documentation for common development tasks
|
||||
* **AGENTS.md**: Guide for AI assistants to understand the project structure
|
||||
* **.agents/**: Detailed workflow documentation for common development tasks
|
||||
* **Starter Prompt**: Comprehensive prompt for AI tools to help customize the template (available in the wiki)
|
||||
|
||||
**Important**: For the best AI assistance, add the .ai-assistant.md file and .ai-workflows/ directory to your AI IDE chat context. In most AI IDEs, you can pin these files to ensure they're considered in each message.
|
||||
**Important**: For the best AI assistance, add the AGENTS.md file and .agents/ directory to your AI IDE chat context. In most AI IDEs, you can pin these files to ensure they're considered in each message.
|
||||
|
||||
= Development Environment =
|
||||
|
||||
@@ -160,7 +160,7 @@ For more information on coding standards and how to pass code quality checks, se
|
||||
|
||||
1. Clone or download this repository
|
||||
2. Read the Starter Prompt file in the wiki for detailed instructions
|
||||
3. Add the .ai-assistant.md file and .ai-workflows/ directory to your AI IDE chat context
|
||||
3. Add the AGENTS.md file and .agents/ directory to your AI IDE chat context
|
||||
4. Use the prompt in the Starter Prompt file to guide the AI in customizing the template
|
||||
5. Rename files and update namespaces to match your plugin
|
||||
6. Customize the functionality for your specific needs
|
||||
@@ -173,7 +173,7 @@ For detailed instructions, see the [Starter Prompt](https://github.com/wpallstar
|
||||
|
||||
= How do I customize this template for my plugin? =
|
||||
|
||||
See the [Starter Prompt](https://github.com/wpallstars/wp-plugin-starter-template-for-ai-coding/wiki/Starter-Prompt) file in the wiki for detailed instructions on customizing this template for your specific plugin needs. Make sure to add the .ai-assistant.md file and .ai-workflows/ directory to your AI IDE chat context for the best results.
|
||||
See the [Starter Prompt](https://github.com/wpallstars/wp-plugin-starter-template-for-ai-coding/wiki/Starter-Prompt) file in the wiki for detailed instructions on customizing this template for your specific plugin needs. Make sure to add the AGENTS.md file and .agents/ directory to your AI IDE chat context for the best results.
|
||||
|
||||
= What files do I need to update with my plugin information? =
|
||||
|
||||
@@ -187,7 +187,7 @@ The main files you need to update include:
|
||||
7. languages/pot file
|
||||
8. .github/workflows/
|
||||
9. .wiki/
|
||||
10. .ai-assistant.md
|
||||
10. AGENTS.md
|
||||
11. includes/plugin.php
|
||||
12. includes/core.php
|
||||
13. admin/lib/admin.php
|
||||
@@ -228,6 +228,14 @@ npm run multisite
|
||||
|
||||
== Changelog ==
|
||||
|
||||
= 0.1.15 =
|
||||
* Release: Maintenance release
|
||||
|
||||
= 0.1.14 =
|
||||
* Changed: Renamed .ai-assistant.md to AGENTS.md for better discoverability
|
||||
* Changed: Renamed .ai-workflows directory to .agents
|
||||
* Updated: All references to these files in documentation and codebase
|
||||
|
||||
= 0.1.13 =
|
||||
* Improved: Code quality with proper type declarations
|
||||
* Fixed: Inconsistent variable naming (camelCase to snake_case)
|
||||
@@ -278,7 +286,7 @@ npm run multisite
|
||||
|
||||
= 0.1.3 =
|
||||
* 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 AGENTS.md and .agents/
|
||||
* Moved: Starter Prompt to the wiki for better organization
|
||||
* Updated: README.md and readme.txt with AI IDE context recommendations
|
||||
* Improved: Documentation for AI-assisted development
|
||||
@@ -303,6 +311,12 @@ npm run multisite
|
||||
|
||||
== Upgrade Notice ==
|
||||
|
||||
= 0.1.15 =
|
||||
Maintenance release.
|
||||
|
||||
= 0.1.14 =
|
||||
Renamed AI assistant documentation files to AGENTS.md and .agents/ directory.
|
||||
|
||||
= 0.1.13 =
|
||||
Improved code quality with proper type declarations, consistent variable naming, and better path handling.
|
||||
|
||||
@@ -331,7 +345,7 @@ Fixed GitHub Actions workflows permissions for releases and wiki sync.
|
||||
Fixed release workflow and added testing setup with wp-env and Cypress, multisite compatibility, and npm scripts for development and testing.
|
||||
|
||||
= 0.1.3 =
|
||||
Added improved AI IDE context recommendations and moved Starter Prompt to the wiki with guidance on pinning .ai-assistant.md and .ai-workflows/ files.
|
||||
Added improved AI IDE context recommendations and moved Starter Prompt to the wiki with guidance on pinning AGENTS.md and .agents/ files.
|
||||
|
||||
= 0.1.1 =
|
||||
Updated LICENSE file with correct GPL-2.0 text.
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
* Plugin Name: WordPress Plugin Starter Template
|
||||
* Plugin URI: https://www.wpallstars.com
|
||||
* Description: A comprehensive starter template for WordPress plugins with best practices for AI-assisted development.
|
||||
* Version: 0.1.13
|
||||
* Version: 0.1.15
|
||||
* Author: Your Name & The WPALLSTARS Team
|
||||
* Author URI: https://www.wpallstars.com
|
||||
* License: GPL-2.0+
|
||||
@@ -35,7 +35,7 @@ if ( ! defined( 'WPINC' ) ) {
|
||||
define( 'WP_PLUGIN_STARTER_TEMPLATE_FILE', __FILE__ );
|
||||
define( 'WP_PLUGIN_STARTER_TEMPLATE_PATH', plugin_dir_path( __FILE__ ) );
|
||||
define( 'WP_PLUGIN_STARTER_TEMPLATE_URL', plugin_dir_url( __FILE__ ) );
|
||||
define( 'WP_PLUGIN_STARTER_TEMPLATE_VERSION', '0.1.13' );
|
||||
define( 'WP_PLUGIN_STARTER_TEMPLATE_VERSION', '0.1.15' );
|
||||
|
||||
// Use namespace imports instead of require_once.
|
||||
use WPALLSTARS\PluginStarterTemplate\Plugin;
|
||||
|
||||
Reference in New Issue
Block a user