From f6d30e92d0d868a2ffb86ecf25529aab2cd80f6b Mon Sep 17 00:00:00 2001 From: marcusquinn <6428977+marcusquinn@users.noreply.github.com> Date: Mon, 24 Nov 2025 22:12:43 +0000 Subject: [PATCH] Fix additional Markdown line lengths for Codacy compliance - Break long prose lines to under 120 characters - Improve readability of documentation - URLs and ASCII art diagrams left unchanged (cannot be shortened) --- .agents/error-checking-feedback-loops.md | 4 +++- .wiki/Multisite-Development.md | 11 +++++++---- .wiki/Testing-Framework.md | 4 +++- AGENTS.md | 14 +++++++++----- README.md | 12 ++++++++---- 5 files changed, 30 insertions(+), 15 deletions(-) diff --git a/.agents/error-checking-feedback-loops.md b/.agents/error-checking-feedback-loops.md index 8d079af..aafbdf5 100644 --- a/.agents/error-checking-feedback-loops.md +++ b/.agents/error-checking-feedback-loops.md @@ -2,7 +2,9 @@ This document outlines the processes for error checking, debugging, and establishing feedback loops. -The goal is to create a seamless, autonomous CI/CD pipeline where the AI can identify, diagnose, and fix issues with minimal human intervention. +The goal is to create a seamless, autonomous CI/CD pipeline. + +The AI can identify, diagnose, and fix issues with minimal human intervention. ## Table of Contents diff --git a/.wiki/Multisite-Development.md b/.wiki/Multisite-Development.md index 3bcd62f..2ea2c81 100644 --- a/.wiki/Multisite-Development.md +++ b/.wiki/Multisite-Development.md @@ -161,12 +161,15 @@ For more details on testing, see the [Testing Framework](Testing-Framework.md) d 2. **Use Network-Specific Functions**: WordPress provides specific functions for multisite. Use `update_site_option()` instead of `update_option()` for network-wide settings. -3. **Handle Blog Switching Properly**: When working with specific sites, use `switch_to_blog()` and `restore_current_blog()`. +3. **Handle Blog Switching Properly**: When working with specific sites, use `switch_to_blog()`. + Always call `restore_current_blog()` when done. -4. **Respect Network Admin Capabilities**: Use appropriate capabilities like `manage_network_options` for network admin pages. +4. **Respect Network Admin Capabilities**: Use capabilities like `manage_network_options` for network admin. -5. **Test in Both Environments**: Always test your plugin in both single site and multisite environments to ensure compatibility. +5. **Test in Both Environments**: Test in both single site and multisite to ensure compatibility. ## Conclusion -By following this guide, you can extend the WordPress Plugin Starter Template to add multisite-specific functionality. The included structure provides a solid foundation for developing features that work seamlessly in multisite environments. +By following this guide, you can extend the WordPress Plugin Starter Template. + +The included structure provides a solid foundation for multisite features. diff --git a/.wiki/Testing-Framework.md b/.wiki/Testing-Framework.md index 52d5298..0ba8a33 100644 --- a/.wiki/Testing-Framework.md +++ b/.wiki/Testing-Framework.md @@ -1,6 +1,8 @@ # WordPress Plugin Testing Framework -This document outlines how to set up and run tests for our plugin in both single site and multisite WordPress environments. +This document outlines how to set up and run tests for our plugin. + +It covers both single site and multisite WordPress environments. ## Overview diff --git a/AGENTS.md b/AGENTS.md index 92b2b03..a33e9d1 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -4,11 +4,15 @@ This guide helps AI assistants understand the project structure, workflows, and ## IMPORTANT: Repository Context -This workspace may contain multiple repository folders. Always focus ONLY on the current repository you're working in and avoid hallucinating functionality from other repositories in the workspace. +This workspace may contain multiple repository folders. + +Always focus ONLY on the current repository you're working in. + +Avoid hallucinating functionality from other repositories in the workspace. * **Current Repository**: wp-plugin-starter-template-for-ai-coding -* **Repository Purpose**: A comprehensive starter template for WordPress plugins with best practices for AI-assisted development -* **Repository Scope**: All code changes, documentation, and functionality discussions should be limited to THIS repository only +* **Repository Purpose**: A starter template for WordPress plugins with AI-assisted development +* **Repository Scope**: All code changes and discussions should be limited to THIS repository only ## Project Overview @@ -39,7 +43,7 @@ This workspace may contain multiple repository folders. Always focus ONLY on the ## Coding Standards -This project follows the [WordPress Coding Standards](https://developer.wordpress.org/coding-standards/wordpress-coding-standards/): +This project follows the [WordPress Coding Standards](https://developer.wordpress.org/coding-standards/): * Use 4 spaces for indentation, not tabs (this is a project-specific override of WordPress standards) * Follow WordPress naming conventions: @@ -87,7 +91,7 @@ Always run PHPCS and PHPCBF locally before committing code to ensure it meets th ## Common Tasks -For detailed instructions on common tasks like creating releases, adding features, fixing bugs, and testing previous versions, see **@.agents/release-process.md**. +For detailed instructions on releases, features, bugs, and testing, see **@.agents/release-process.md**. ## Avoiding Cross-Repository Confusion diff --git a/README.md b/README.md index 97e149e..a15c90d 100644 --- a/README.md +++ b/README.md @@ -6,9 +6,11 @@ A comprehensive starter template for WordPress plugins with best practices for A ## Description -The WordPress Plugin Starter Template provides a solid foundation for developing WordPress plugins. It incorporates best practices, modern coding standards, and a comprehensive structure that makes it easy to get started with plugin development. +The WordPress Plugin Starter Template provides a solid foundation for developing WordPress plugins. -This template is based on the experience gained from developing the "Fix 'Plugin file does not exist' Notices" plugin and other successful WordPress plugins. +It incorporates best practices, modern coding standards, and a comprehensive structure. + +This template is based on experience from developing successful WordPress plugins. ### Key Features @@ -39,9 +41,11 @@ This template includes comprehensive documentation for AI-assisted development: * **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)) +* **Starter Prompt**: Prompt for AI tools to customize the template ([wiki](.wiki/Starter-Prompt.md)) -**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. +**Important**: For the best AI assistance, add AGENTS.md and .agents/ to your AI IDE chat context. + +In most AI IDEs, you can pin these files to ensure they're considered in each message. ## Installation