From e3319c49599d2e131bffec91dfe91239919c7108 Mon Sep 17 00:00:00 2001 From: Marcus Quinn <6428977+marcusquinn@users.noreply.github.com> Date: Sat, 12 Apr 2025 00:50:49 +0100 Subject: [PATCH] Update README.md and improve .ai-assistant.md documentation --- .ai-assistant.md | 36 +++++++++++++++++++++++++------ README.md | 56 ++++++++++++++++++++++++++---------------------- 2 files changed, 59 insertions(+), 33 deletions(-) diff --git a/.ai-assistant.md b/.ai-assistant.md index 5f7c8b2..fdd9c7a 100644 --- a/.ai-assistant.md +++ b/.ai-assistant.md @@ -20,7 +20,7 @@ We follow [Semantic Versioning](https://semver.org/): ### When to Increment Version Numbers -- **PATCH** (1.6.0 → 1.6.1): +- **PATCH** (1.6.0 → 1.6.1): - Bug fixes - Small text changes - Minor improvements that don't add new features @@ -41,7 +41,10 @@ When updating the version number, always update these files: 1. `fix-plugin-does-not-exist-notices.php` (Plugin header) 2. `CHANGELOG.md` (Add new version section) 3. `readme.txt` (Stable tag and Changelog section) -4. Update `FPDEN_VERSION` constant in the main plugin file +4. `README.md` (Update Changelog section to match readme.txt) +5. Update `FPDEN_VERSION` constant in the main plugin file + +**IMPORTANT**: Always ensure README.md is kept in sync with readme.txt for consistency across platforms. ## Git Workflow @@ -58,23 +61,41 @@ When updating the version number, always update these files: - Keep the first line under 50 characters - Reference issues when relevant: "Fix #123: Resolve plugin detection issue" +### Pre-Release Checklist + +Before creating a new release, verify the following: + +- [ ] Determine the correct version increment (MAJOR, MINOR, or PATCH) based on the changes +- [ ] Ensure all changes are documented in CHANGELOG.md +- [ ] Verify all code changes are tested and working correctly +- [ ] Check that all files are properly formatted and follow WordPress coding standards +- [ ] Ensure Git Updater configuration is correct (if applicable) + ### Release Process 1. Create a new branch for the version: `git checkout -b v{MAJOR}.{MINOR}.{PATCH}` -2. Update version numbers in all required files +2. Update version numbers in ALL required files: + - `fix-plugin-does-not-exist-notices.php` (Plugin header) + - `FPDEN_VERSION` constant in the main plugin file + - `readme.txt` (Stable tag) + - `README.md` (Ensure changelog is updated) + - Any other files that reference the version number 3. Update CHANGELOG.md with all changes -4. Commit changes: `git commit -m "Prepare release v{MAJOR}.{MINOR}.{PATCH}"` -5. Push branch to all remotes: +4. Update readme.txt changelog section +5. Update README.md changelog section to match readme.txt +6. Commit changes: `git commit -m "Prepare release v{MAJOR}.{MINOR}.{PATCH}"` +7. Push branch to all remotes: ``` git push github HEAD:v{MAJOR}.{MINOR}.{PATCH} git push gitea HEAD:v{MAJOR}.{MINOR}.{PATCH} ``` -6. Create and push a tag to trigger the GitHub Actions workflow: +8. Create and push a tag to trigger the GitHub Actions workflow: ``` git tag -a v{MAJOR}.{MINOR}.{PATCH} -m "Release version {MAJOR}.{MINOR}.{PATCH}" git push github refs/tags/v{MAJOR}.{MINOR}.{PATCH} git push gitea refs/tags/v{MAJOR}.{MINOR}.{PATCH} ``` +9. Verify the GitHub Actions workflow completes successfully ## Build Process @@ -122,10 +143,11 @@ Before releasing: # 1. Create a new branch git checkout -b v1.7.0 -# 2. Update version numbers in files +# 2. Update version numbers in ALL required files # - fix-plugin-does-not-exist-notices.php # - CHANGELOG.md # - readme.txt +# - README.md # - FPDEN_VERSION constant # 3. Commit changes diff --git a/README.md b/README.md index 8c08bb7..34dc62e 100644 --- a/README.md +++ b/README.md @@ -120,35 +120,39 @@ The plugin works by: ## Changelog -### 1.4.1 -- Added FAQ about keeping the plugin installed after notices are cleared +### 1.6.3 +* Fixed Git Updater repository URLs to use full repository paths +* Corrected Update URI configuration for proper update detection +* Improved version management following semantic versioning -### 1.4.0 -- Updated plugin name and text domain -- Repository rename from plugin-reference-cleaner to fix-plugin-does-not-exist-notices +### 1.6.2 +* Updated POT file version for consistency +* Improved JavaScript localization with proper fallbacks +* Enhanced code quality for WordPress.org submission +* Added Git Updater configuration with Update URI +* Added update server URL configuration -### 1.3.3 -* Improved notification placement next to WordPress error messages -* Added "Click here to scroll" button that automatically locates missing plugins -* Enhanced reliability with multiple injection methods -* Added visual arrow pointing from notification to error message +### 1.6.1 +* Added AI assistant guide and workflow documentation +* Added detailed release process documentation +* Added feature development guidelines +* Added bug fixing procedures +* Added code review standards -### 1.3.2 -* Added prominent notification directly below WordPress error messages -* Improved user guidance with visual cues to connect error and solution -* Added eye-catching styling to help users understand how to fix errors +### 1.6.0 +* Added full translation support with POT file +* Added JavaScript localization for better multilingual support +* Added plugin constants for improved code organization +* Added Git Updater support for updates from GitHub and Gitea +* Updated code to follow WordPress internationalization best practices +* Improved asset loading with version constants +* Added smart update detection based on installation source -### 1.3.1 -* Added instructional notification explaining how to use the plugin -* Improved user guidance with step-by-step instructions -* Enhanced visual identification of missing plugins - -### 1.3.0 -* Complete redesign for maximum compatibility with all WordPress themes -* Now adds missing plugins directly to the plugins list table -* Uses standard WordPress admin UI patterns instead of DOM manipulation -* Added "Remove Reference" action link in the plugins list -* Significantly improved reliability across all WordPress configurations +### 1.5.0 +* Improved compatibility with WordPress 6.4 +* Enhanced error detection for plugin references +* Minor UI improvements for better visibility +* Accessibility enhancements for screen readers [View full changelog](CHANGELOG.md) @@ -158,4 +162,4 @@ This project is licensed under the GPL-2.0+ License - see the [LICENSE](LICENSE) ## Support -For support, please visit [WP All Stars](https://www.wpallstars.com). \ No newline at end of file +For support, please visit [WP All Stars](https://www.wpallstars.com). \ No newline at end of file