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

Fix Markdown line lengths for Codacy compliance

Browse Source 
- Break long lines in documentation files to stay under 120 characters
- Use reference-style links for long URLs
- Simplify ASCII art diagram in error-checking-feedback-loops.md
- Reorganize README.md badges with reference-style links
This commit is contained in:
Marcus Quinn
2025-11-25 00:17:35 +00:00
parent 3f695bb003
commit b58036f3f5
7 changed files with 99 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
.agents/code-review.md
View File

@@ -8,8 +8,13 @@ This document provides guidance for AI assistants to help with code review for t
Before submitting code for review, test it with WordPress Playground:
* [ ] Test in single site environment: [Open in WordPress Playground](https://playground.wordpress.net/?blueprint-url=https://raw.githubusercontent.com/wpallstars/wp-plugin-starter-template-for-ai-coding/main/playground/blueprint.json&_t=5)
* [ ] Test in multisite environment: [Open in WordPress Playground](https://playground.wordpress.net/?blueprint-url=https://raw.githubusercontent.com/wpallstars/wp-plugin-starter-template-for-ai-coding/main/playground/multisite-blueprint.json&_t=18)
* [ ] Test in single site environment:
[Open in WordPress Playground][playground-single]
* [ ] Test in multisite environment:
[Open in WordPress Playground][playground-multisite]
[playground-single]: https://playground.wordpress.net/?blueprint-url=https://raw.githubusercontent.com/wpallstars/wp-plugin-starter-template-for-ai-coding/main/playground/blueprint.json&_t=5
[playground-multisite]: https://playground.wordpress.net/?blueprint-url=https://raw.githubusercontent.com/wpallstars/wp-plugin-starter-template-for-ai-coding/main/playground/multisite-blueprint.json&_t=18
* [ ] Verify plugin functionality works in both environments
* [ ] Check for any JavaScript errors in the browser console
* [ ] Run Cypress tests locally: `npm run test:playground:single` and `npm run test:playground:multisite`
@@ -257,10 +262,20 @@ In function `handle_remove_reference()`:
3. The success message should be translatable:
```php
// Change this:
add_settings_error('fpden', 'fpden_removed', 'Plugin reference removed successfully.', 'updated');
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');
add_settings_error(
'fpden',
'fpden_removed',
__( 'Plugin reference removed successfully.', 'fix-plugin-does-not-exist-notices' ),
'updated'
);
```
```

28
.agents/error-checking-feedback-loops.md
View File

@@ -365,27 +365,13 @@ function get_plugin_version() { ... }
### Complete Feedback Loop System
```
┌─────────────────┐ ┌─────────────────┐ ┌─────────────────┐
│ │ │ │ │ │
│ Code Changes │────▶│ Local Testing │────▶│ GitHub Actions │
│ │ │ │ │ │
└────────┬────────┘ └────────┬────────┘ └────────┬────────┘
│ │ │
│ │ │
│ │ │
┌────────▼────────┐ ┌────────▼────────┐ ┌────────▼────────┐
│ │ │ │ │ │
│ AI Assistant │◀────│ Error Analysis │◀────│ Status Check │
│ │ │ │ │ │
└────────┬────────┘ └─────────────────┘ └─────────────────┘
│
│
│
┌────────▼────────┐ ┌─────────────────┐
│ │ │ │
│ Fix Generation │────▶│ Human Review │ (only when necessary)
│ │ │ │
└─────────────────┘ └─────────────────┘
Code Changes ──► Local Testing ──► GitHub Actions
│ │ │
▼ ▼ ▼
AI Assistant ◀── Error Analysis ◀── Status Check
│
▼
Fix Generation ──► Human Review (only when necessary)
```
### Key Components