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

Global search & replace .ai-assistant.md to AGENTS.md and .ai-workflows to .agents

Browse Source
This commit is contained in:
Marcus Quinn
2025-11-24 00:25:33 +00:00
parent 6300b687aa
commit 84952ff2d1
12 changed files with 35 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
.agents/bug-fixing.md
View File

@@ -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`). 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 ### 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. 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 ## Testing Previous Versions

2
.agents/code-quality-checks.md
View File

@@ -147,7 +147,7 @@ I ran PHPCS and got the following errors. Can you help me fix them?
[Paste error output here] [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 ## Conclusion

6
.agents/dev-prefs-memory.md
View File

@@ -31,9 +31,9 @@ This document serves as a persistent memory for developer preferences establishe
### Documentation ### Documentation
- Prefer token-efficient documentation in `.ai-assistant.md` that references `.ai-workflows/` files - Prefer token-efficient documentation in `AGENTS.md` that references `.agents/` files
- Document the release workflow in `.ai-assistant.md` and `.ai-workflows/release-process.md` - Document the release workflow in `AGENTS.md` and `.agents/release-process.md`
- Store environment variable documentation in `.ai-workflows/local-env-vars.md` - Store environment variable documentation in `.agents/local-env-vars.md`
- Maintain consistent documentation across readme.txt, README.md, and CHANGELOG.md - Maintain consistent documentation across readme.txt, README.md, and CHANGELOG.md
### Asset Organization ### Asset Organization

8
.agents/feature-development.md
View File

@@ -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`). 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 ### 2. Implement the Feature
@@ -44,7 +44,7 @@ Update relevant documentation to reflect the new feature:
- Add screenshots or examples if applicable - Add screenshots or examples if applicable
- Remember that any feature addition will require a version increment in all relevant files - 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 ### 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. **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) ### 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 - Adapt the feature to fit the current repository's needs and architecture
- Document the inspiration source in code comments - 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 ## Feature Types and Implementation Guidelines

2
.agents/folder-structure.md
View File

@@ -8,7 +8,7 @@ This document outlines the folder structure of the plugin and explains the purpo
- **includes/** - Contains core plugin functionality and classes - **includes/** - Contains core plugin functionality and classes
- **languages/** - Contains translation files - **languages/** - Contains translation files
- **scripts/** - Contains build and deployment scripts - **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 - **.github/** - Contains GitHub-specific files like workflows
- **.wordpress-org/** - Contains WordPress.org assets like banners and screenshots - **.wordpress-org/** - Contains WordPress.org assets like banners and screenshots

4
.agents/git-workflow.md
View File

@@ -186,7 +186,7 @@ When preparing for a release:
- Update version numbers - Update version numbers
- Update changelogs - Update changelogs
- Create tag - Create tag
- See **@.ai-workflows/release-process.md** for complete details - See **@.agents/release-process.md** for complete details
## Contributing to External Repositories ## 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 - Review code thoroughly before approving
- Test changes locally when possible - Test changes locally when possible
- Provide constructive feedback - 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 ### Suggested Improvements

2
.agents/wiki-documentation.md
View File

@@ -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 - If referencing functionality from another repository, clearly indicate that it's external
- Use phrases like "unlike Repository X, this plugin does not include..." - 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 ## Best Practices

8
CHANGELOG.md
View File

@@ -1,5 +1,13 @@
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.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 #### [0.1.13] - 2023-04-23
#### Improved #### Improved

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.10", "version": "0.1.14",
"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.10", "version": "0.1.14",
"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.13 Stable tag: 0.1.14
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
@@ -228,6 +228,11 @@ npm run multisite
== Changelog == == Changelog ==
= 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 = = 0.1.13 =
* Improved: Code quality with proper type declarations * Improved: Code quality with proper type declarations
* Fixed: Inconsistent variable naming (camelCase to snake_case) * Fixed: Inconsistent variable naming (camelCase to snake_case)
@@ -303,6 +308,9 @@ npm run multisite
== Upgrade Notice == == Upgrade Notice ==
= 0.1.14 =
Renamed AI assistant documentation files to AGENTS.md and .agents/ directory.
= 0.1.13 = = 0.1.13 =
Improved code quality with proper type declarations, consistent variable naming, and better path handling. Improved code quality with proper type declarations, consistent variable naming, and better path handling.

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.13 * Version: 0.1.14
* 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,7 +35,7 @@ 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 and store the instance in a global variable. // Initialize the plugin and store the instance in a global variable.
$wpst_plugin = new WPALLSTARS\PluginStarterTemplate\Plugin( __FILE__, '0.1.13' ); $wpst_plugin = new WPALLSTARS\PluginStarterTemplate\Plugin( __FILE__, '0.1.14' );
// Initialize the plugin. // Initialize the plugin.
$wpst_plugin->init(); $wpst_plugin->init();