From c70b316a270eaabd669decfc6b8e8c3d12b93d31 Mon Sep 17 00:00:00 2001 From: Marcus Quinn <6428977+marcusquinn@users.noreply.github.com> Date: Sat, 12 Apr 2025 22:29:42 +0100 Subject: [PATCH] Improve documentation and prepare for WordPress.org submission (v2.0.1) --- .ai-assistant.md | 11 +++ .ai-workflows/feature-development.md | 1 + .gitattributes | 92 ++++++++++++++++--- .gitignore | 3 + CHANGELOG.md | 10 ++ README.md | 22 +++-- fix-plugin-does-not-exist-notices.php | 4 +- .../fix-plugin-does-not-exist-notices.pot | 2 +- readme.txt | 26 +++++- 9 files changed, 145 insertions(+), 26 deletions(-) diff --git a/.ai-assistant.md b/.ai-assistant.md index ead8986..0d97ec2 100644 --- a/.ai-assistant.md +++ b/.ai-assistant.md @@ -29,6 +29,17 @@ All these files respect `.gitignore` patterns and only include additional tool-s This section should be updated with your specific plugin information. The current implementation is for the "Fix 'Plugin file does not exist.' Notices" plugin, which adds missing plugins to the plugins list with a "Remove Notice" link to clean up invalid plugin entries and remove error notices. +## Reference Plugins + +The `reference-plugins/` directory contains plugins that can be used for reference or inspiration. When developing new features or improving existing ones, you should: + +1. Examine these reference plugins for best practices in code structure, organization, and implementation +2. Look for patterns in how they handle similar functionality +3. Consider their approach to user interface design and user experience +4. Study their documentation style and thoroughness + +These plugins are not part of the codebase and are ignored by Git, but they provide valuable examples of WordPress plugin development standards and techniques. + ## Version Management ### Version Numbering Convention diff --git a/.ai-workflows/feature-development.md b/.ai-workflows/feature-development.md index 7730c13..122920a 100644 --- a/.ai-workflows/feature-development.md +++ b/.ai-workflows/feature-development.md @@ -25,6 +25,7 @@ When implementing a new feature: - Add appropriate comments - Consider performance implications - Maintain backward compatibility +- Review reference plugins in the `reference-plugins/` directory for inspiration and best practices ### 3. Update Documentation diff --git a/.gitattributes b/.gitattributes index 89d824f..6cfa630 100644 --- a/.gitattributes +++ b/.gitattributes @@ -4,32 +4,98 @@ # Auto detect text files and perform LF normalization * text=auto -# Text files that should be normalized -*.php text -*.css text -*.js text -*.htm text -*.html text -*.xml text -*.txt text -*.ini text -*.inc text -*.md text -.htaccess text +# Text files that should be normalized with LF line endings +*.php text eol=lf +*.css text eol=lf +*.js text eol=lf +*.scss text eol=lf +*.htm text eol=lf +*.html text eol=lf +*.xml text eol=lf +*.txt text eol=lf +*.ini text eol=lf +*.inc text eol=lf +*.md text eol=lf +*.json text eol=lf +*.yml text eol=lf +*.yaml text eol=lf +*.po text eol=lf +*.pot text eol=lf +*.svg text eol=lf +.htaccess text eol=lf # Files that should be treated as binary *.png binary *.jpg binary +*.jpeg binary *.gif binary *.ico binary +*.webp binary *.zip binary *.gz binary *.tar binary *.ttf binary *.eot binary *.woff binary +*.woff2 binary +*.pxd binary +*.afdesign binary +*.afphoto binary +*.afpub binary + +# Exclude files from export (for WordPress.org SVN and distribution packages) +.gitattributes export-ignore +.gitignore export-ignore +.github export-ignore +.wordpress-org export-ignore +README.md export-ignore +CHANGELOG.md export-ignore +composer.json export-ignore +composer.lock export-ignore +package.json export-ignore +package-lock.json export-ignore +phpcs.xml export-ignore +.phpcs.xml export-ignore +phpunit.xml export-ignore +.phpunit.xml export-ignore +.distignore export-ignore +.editorconfig export-ignore +.eslintrc export-ignore +.eslintignore export-ignore +.prettierrc export-ignore +.prettierignore export-ignore +.stylelintrc export-ignore +.stylelintignore export-ignore +.travis.yml export-ignore +.gitlab-ci.yml export-ignore +bitbucket-pipelines.yml export-ignore +bin export-ignore +tests export-ignore +assets/icon/*.svg export-ignore +assets/banner/*.svg export-ignore +assets/screenshots/*.pxd export-ignore +assets/icon/*.pxd export-ignore +assets/banner/*.pxd export-ignore + +# AI assistant and workflow files +.ai-assistant.md export-ignore +.ai-workflows export-ignore +.augmentignore export-ignore +.cursorignore export-ignore +.v0ignore export-ignore +.clinerc export-ignore +.continuerc export-ignore +reference-plugins export-ignore # Set the default behavior for GitHub language detection *.css linguist-language=CSS *.js linguist-language=JavaScript -*.php linguist-language=PHP \ No newline at end of file +*.php linguist-language=PHP +*.scss linguist-language=SCSS +*.pot linguist-language=Gettext Catalog +*.po linguist-language=Gettext Catalog +*.mo linguist-language=Gettext Catalog + +# Merge driver for changelog files to prevent conflicts +CHANGELOG.md merge=union +readme.txt merge=union \ No newline at end of file diff --git a/.gitignore b/.gitignore index 9166d81..326a43e 100644 --- a/.gitignore +++ b/.gitignore @@ -45,6 +45,9 @@ wp-content/backup-db/ wp-content/cache/ wp-content/backups/ +# Reference plugins +reference-plugins/ + # Log files *.log error_log diff --git a/CHANGELOG.md b/CHANGELOG.md index 8ba2bb6..e88258f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,16 @@ All notable changes to this project will be documented in this file. +## [2.0.1] - 2024-05-17 +### Added +- Contributing section to readme.txt +- reference-plugins directory for plugin development inspiration + +### Changed +- Updated "tested up to" version to WordPress 6.7.2 +- Improved .gitattributes with comprehensive file handling +- Enhanced documentation organization + ## [2.0.0] - 2024-05-17 ### Added - Note clarifying that the plugin has no settings page diff --git a/README.md b/README.md index 4327268..6eecdc3 100644 --- a/README.md +++ b/README.md @@ -136,15 +136,14 @@ Contributions are welcome! Please feel free to submit a Pull Request. This repository is configured to work with various AI-powered development tools. You can use any of the following AI IDEs to contribute to this project: -- [Augment](https://augment.dev/) - AI-powered coding assistant -- [Cursor](https://cursor.sh/) - AI-first code editor +- [Augment Code](https://www.augmentcode.com/) - AI-powered coding assistant +- [Cursor](https://cursor.com/) - AI-first code editor - [v0](https://v0.dev/) - AI-powered design and development tool -- [Windsurf](https://www.windsurf.io/) - AI coding assistant -- [Cline](https://cline.tools/) - AI terminal assistant -- [Roo](https://roo.ai/) - AI pair programmer -- [Gemini Code Assist](https://ai.google.dev/gemini-api) - Google's AI coding assistant -- [Loveable](https://www.loveable.ai/) - AI development environment -- [Bolt](https://www.bolt.dev/) - AI-powered code editor +- [Windsurf](https://www.windsurf.com/) - AI coding assistant +- [Cline](https://cline.bot/) - AI terminal assistant +- [Roo Code](https://roocode.com/) - AI pair programmer +- [Loveable](https://lovable.dev/) - AI development environment +- [Bolt](https://www.bolt.new/) - AI-powered code editor - [Cody](https://sourcegraph.com/cody) - Sourcegraph's AI coding assistant - [Continue](https://continue.dev/) - Open-source AI coding assistant @@ -160,6 +159,13 @@ The plugin works by: ## Changelog +### 2.0.1 +* Added Contributing section to readme.txt +* Updated "tested up to" version to WordPress 6.7.2 +* Added reference-plugins directory for plugin development inspiration +* Improved .gitattributes with comprehensive file handling +* Enhanced documentation organization + ### 2.0.0 * Major version release for WordPress.org submission * Added note clarifying that the plugin has no settings page diff --git a/fix-plugin-does-not-exist-notices.php b/fix-plugin-does-not-exist-notices.php index 39a6b24..bbff519 100644 --- a/fix-plugin-does-not-exist-notices.php +++ b/fix-plugin-does-not-exist-notices.php @@ -13,7 +13,7 @@ * Plugin Name: Fix 'Plugin file does not exist.' Notices * Plugin URI: https://wordpress.org/plugins/fix-plugin-does-not-exist-notices/ * Description: Adds missing plugins to the plugins list with a "Remove Reference" link so you can permanently clean up invalid plugin entries and remove error notices. - * Version: 2.0.0 + * Version: 2.0.1 * Author: Marcus Quinn & WP ALLSTARS * Author URI: https://www.wpallstars.com * License: GPL-2.0+ @@ -48,7 +48,7 @@ if ( ! defined( 'ABSPATH' ) ) { } // Define plugin constants -define( 'FPDEN_VERSION', '2.0.0' ); +define( 'FPDEN_VERSION', '2.0.1' ); define( 'FPDEN_PLUGIN_DIR', plugin_dir_path( __FILE__ ) ); define( 'FPDEN_PLUGIN_URL', plugin_dir_url( __FILE__ ) ); define( 'FPDEN_PLUGIN_FILE', __FILE__ ); diff --git a/languages/fix-plugin-does-not-exist-notices.pot b/languages/fix-plugin-does-not-exist-notices.pot index 248db65..fa6684a 100644 --- a/languages/fix-plugin-does-not-exist-notices.pot +++ b/languages/fix-plugin-does-not-exist-notices.pot @@ -2,7 +2,7 @@ # This file is distributed under the GPL-2.0+. msgid "" msgstr "" -"Project-Id-Version: Fix 'Plugin file does not exist.' Notices 2.0.0\n" +"Project-Id-Version: Fix 'Plugin file does not exist.' Notices 2.0.1\n" "Report-Msgid-Bugs-To: https://wordpress.org/support/plugin/fix-plugin-does-not-exist-notices\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" diff --git a/readme.txt b/readme.txt index f6a27bb..9d7baef 100644 --- a/readme.txt +++ b/readme.txt @@ -3,9 +3,9 @@ Contributors: marcusquinn, wpallstars Donate link: https://www.marcusquinn.com Tags: plugins, missing plugins, cleanup, error fix, admin tools, plugin file does not exist, wordpress error, plugin error, deactivated plugin, remove plugin reference, fix plugin error, plugin does not exist, plugin file does not exist error Requires at least: 5.0 -Tested up to: 6.4 +Tested up to: 6.7.2 Requires PHP: 7.0 -Stable tag: 2.0.0 +Stable tag: 2.0.1 License: GPL-2.0+ License URI: https://www.gnu.org/licenses/gpl-2.0.html @@ -111,6 +111,13 @@ Manually editing the WordPress database is risky and requires technical knowledg == Changelog == += 2.0.1 = +* Added Contributing section to readme.txt +* Updated "tested up to" version to WordPress 6.7.2 +* Added reference-plugins directory for plugin development inspiration +* Improved .gitattributes with comprehensive file handling +* Enhanced documentation organization + = 2.0.0 = * Major version release for WordPress.org submission * Added note clarifying that the plugin has no settings page @@ -372,6 +379,9 @@ Manually editing the WordPress database is risky and requires technical knowledg == Upgrade Notice == += 2.0.1 = +Improved documentation with Contributing section and updated WordPress compatibility to 6.7.2. + = 2.0.0 = Major version release for WordPress.org submission with improved documentation and clarification about plugin functionality. @@ -453,6 +463,18 @@ Completely redesigned for better compatibility with all WordPress themes - now w = 1.2.2 = Important stability fix - resolves timeout issues during plugin activation! +== Contributing == + +Contributions are welcome! Please feel free to submit a Pull Request. + +1. Fork the repository on [GitHub](https://github.com/wpallstars/fix-plugin-does-not-exist-notices/) or [Gitea](https://gitea.wpallstars.com/wpallstars/fix-plugin-does-not-exist-notices/) +2. Create your feature branch: `git checkout -b feature/amazing-feature` +3. Commit your changes: `git commit -m 'Add some amazing feature'` +4. Push to the branch: `git push origin feature/amazing-feature` +5. Submit a pull request + +The plugin is designed to be a best-practice example for WordPress plugin development and can be used as a boilerplate for your own plugins. + == Support == If you need help with this plugin, there are several ways to get support: