Fixed formatting issues in markdown documentation files
This commit is contained in:
@@ -62,6 +62,7 @@ When reviewing code, check for the following:
|
||||
### 1. Understand the Context
|
||||
|
||||
Before reviewing code, understand:
|
||||
|
||||
- What problem is the code trying to solve?
|
||||
- What are the requirements?
|
||||
- What are the constraints?
|
||||
@@ -73,6 +74,7 @@ Review the code with the checklist above in mind.
|
||||
### 3. Provide Feedback
|
||||
|
||||
When providing feedback:
|
||||
|
||||
- Be specific and clear
|
||||
- Explain why a change is needed
|
||||
- Provide examples or suggestions when possible
|
||||
@@ -82,6 +84,7 @@ When providing feedback:
|
||||
### 4. Follow Up
|
||||
|
||||
After the code has been updated:
|
||||
|
||||
- Review the changes
|
||||
- Verify that issues have been addressed
|
||||
- Provide additional feedback if necessary
|
||||
@@ -128,7 +131,7 @@ After the code has been updated:
|
||||
```
|
||||
In function `handle_remove_reference()`:
|
||||
|
||||
1. The nonce check is missing, which could lead to CSRF vulnerabilities.
|
||||
1. The nonce check is missing, which could lead to CSRF vulnerabilities.
|
||||
Consider adding:
|
||||
```php
|
||||
if (!isset($_GET['_wpnonce']) || !wp_verify_nonce($_GET['_wpnonce'], 'fpden_remove_reference')) {
|
||||
@@ -150,7 +153,7 @@ In function `handle_remove_reference()`:
|
||||
```php
|
||||
// Change this:
|
||||
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');
|
||||
```
|
||||
|
||||
@@ -39,6 +39,7 @@ This document provides guidance for AI assistants to help with incremental devel
|
||||
### Marking Stable Versions
|
||||
|
||||
When the user confirms that changes are working correctly:
|
||||
|
||||
1. Create a version branch and update version numbers
|
||||
2. Tag the version branch as stable
|
||||
```bash
|
||||
@@ -62,6 +63,7 @@ git checkout -b fix/plugin-activation-error
|
||||
### 2. Make Changes Without Updating Version Numbers
|
||||
|
||||
During the development and testing phase:
|
||||
|
||||
- Implement the necessary changes
|
||||
- **Don't update version numbers** in any files yet
|
||||
- Focus on the functionality
|
||||
@@ -79,6 +81,7 @@ CURRENT_VERSION=$(grep -o "Version: [0-9.]*" wp-fix-plugin-does-not-exist-notice
|
||||
```
|
||||
|
||||
This will:
|
||||
|
||||
1. Create a build directory
|
||||
2. Copy required files to the build directory
|
||||
3. Deploy the plugin to your local WordPress testing environment
|
||||
@@ -88,6 +91,7 @@ This will:
|
||||
### 4. Test and Evaluate
|
||||
|
||||
Test the changes thoroughly in the local environment:
|
||||
|
||||
- Verify that the specific issue is fixed or feature works as expected
|
||||
- Check for any regressions or new issues
|
||||
- Document the results
|
||||
|
||||
@@ -3,17 +3,20 @@
|
||||
This file contains important paths and URLs for local development.
|
||||
|
||||
## Repository Paths
|
||||
|
||||
- Local development repository: ~/Git/wp-fix-plugin-does-not-exist-notices
|
||||
- LocalWP plugin testing site storage: ~/Local/plugin-testing/app/wp-fix-plugin-does-not-exist-notices
|
||||
- LocalWP plugin testing site configuration: ~/Local/plugin-testing/conf/
|
||||
|
||||
## URLs
|
||||
- LocalWP plugin testing URL: http://plugin-testing.local/
|
||||
- PHP details: http://plugin-testing.local/local-phpinfo.php
|
||||
- XDebug info: http://plugin-testing.local/local-xdebuginfo.php
|
||||
- Adminer Evo: http://localhost:10010/?username=root&db=local
|
||||
- Mailpit: http://localhost:10000/
|
||||
|
||||
- LocalWP plugin testing URL: <http://plugin-testing.local/>
|
||||
- PHP details: <http://plugin-testing.local/local-phpinfo.php>
|
||||
- XDebug info: <http://plugin-testing.local/local-xdebuginfo.php>
|
||||
- Adminer Evo: <http://localhost:10010/?username=root&db=local>
|
||||
- Mailpit: <http://localhost:10000/>
|
||||
|
||||
## Build and Deploy Scripts
|
||||
|
||||
- Build script: ~/Git/wp-fix-plugin-does-not-exist-notices/build.sh
|
||||
- Local deploy script: ~/Git/wp-fix-plugin-does-not-exist-notices/deploy-local.sh
|
||||
|
||||
@@ -36,6 +36,7 @@ Suggesting changes or improvements based on other repositories, leading to scope
|
||||
### 1. Repository Verification
|
||||
|
||||
**ALWAYS** verify which repository you're currently working in before:
|
||||
|
||||
- Making code suggestions
|
||||
- Creating or updating documentation
|
||||
- Discussing features or functionality
|
||||
@@ -44,6 +45,7 @@ Suggesting changes or improvements based on other repositories, leading to scope
|
||||
### 2. Explicit Code Search Scoping
|
||||
|
||||
When searching for code or functionality:
|
||||
|
||||
- Explicitly limit searches to the current repository
|
||||
- Use repository-specific paths in search queries
|
||||
- Verify search results are from the current repository before using them
|
||||
|
||||
@@ -57,11 +57,13 @@ Build the plugin with the new version:
|
||||
```
|
||||
|
||||
This will:
|
||||
|
||||
- Create a clean build in the `build/` directory
|
||||
- Generate a ZIP file for distribution
|
||||
- Deploy to a local WordPress installation if configured
|
||||
|
||||
Test the plugin thoroughly:
|
||||
|
||||
- Test with the latest WordPress version
|
||||
- Test with the minimum supported WordPress version (5.0)
|
||||
- Test with PHP 7.0+ (minimum supported version)
|
||||
@@ -139,6 +141,7 @@ Follow semantic versioning (MAJOR.MINOR.PATCH):
|
||||
- **PATCH**: Backward-compatible bug fixes
|
||||
|
||||
Examples:
|
||||
|
||||
- Bug fix: 1.0.0 → 1.0.1
|
||||
- New feature: 1.0.0 → 1.1.0
|
||||
- Breaking change: 1.0.0 → 2.0.0
|
||||
|
||||
Reference in New Issue
Block a user