diff --git a/.agents/bug-fixing.md b/.agents/bug-fixing.md index 4e4b8f0..ab0a692 100644 --- a/.agents/bug-fixing.md +++ b/.agents/bug-fixing.md @@ -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 diff --git a/.agents/code-quality-checks.md b/.agents/code-quality-checks.md index ee0331b..8e02e0b 100644 --- a/.agents/code-quality-checks.md +++ b/.agents/code-quality-checks.md @@ -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 diff --git a/.agents/dev-prefs-memory.md b/.agents/dev-prefs-memory.md index 865525d..d1004b5 100644 --- a/.agents/dev-prefs-memory.md +++ b/.agents/dev-prefs-memory.md @@ -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 diff --git a/.agents/feature-development.md b/.agents/feature-development.md index 27c92dd..a09ad7f 100644 --- a/.agents/feature-development.md +++ b/.agents/feature-development.md @@ -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 diff --git a/.agents/folder-structure.md b/.agents/folder-structure.md index e63e665..ffaba88 100644 --- a/.agents/folder-structure.md +++ b/.agents/folder-structure.md @@ -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 diff --git a/.agents/git-workflow.md b/.agents/git-workflow.md index fa1aa19..2f0cba7 100644 --- a/.agents/git-workflow.md +++ b/.agents/git-workflow.md @@ -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 diff --git a/.agents/wiki-documentation.md b/.agents/wiki-documentation.md index 495ea1a..05ed5c9 100644 --- a/.agents/wiki-documentation.md +++ b/.agents/wiki-documentation.md @@ -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 diff --git a/CHANGELOG.md b/CHANGELOG.md index 04c5cd7..cbbf5ef 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,13 @@ 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 #### Improved diff --git a/composer.json b/composer.json index 1da64ad..f1b5d5a 100644 --- a/composer.json +++ b/composer.json @@ -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.14", "license": "GPL-2.0-or-later", "authors": [ { diff --git a/package.json b/package.json index b82dc0e..4766a77 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "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.", "main": "index.js", "scripts": { diff --git a/readme.txt b/readme.txt index 8b43d18..d78c0f7 100644 --- a/readme.txt +++ b/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.14 License: GPL-2.0-or-later License URI: https://www.gnu.org/licenses/gpl-2.0.html @@ -228,6 +228,11 @@ npm run multisite == 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 = * Improved: Code quality with proper type declarations * Fixed: Inconsistent variable naming (camelCase to snake_case) @@ -303,6 +308,9 @@ npm run multisite == Upgrade Notice == += 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. diff --git a/wp-plugin-starter-template.php b/wp-plugin-starter-template.php index 64a57c1..a229977 100644 --- a/wp-plugin-starter-template.php +++ b/wp-plugin-starter-template.php @@ -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.14 * Author: Your Name & The WPALLSTARS Team * Author URI: https://www.wpallstars.com * License: GPL-2.0+ @@ -35,7 +35,7 @@ if ( ! defined( 'WPINC' ) ) { require_once plugin_dir_path( __FILE__ ) . 'includes/class-plugin.php'; // 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. $wpst_plugin->init();