Initial commit of WordPress Plugin Starter Template for AI Coding
Some checks failed
Tests / PHP 7.0 (push) Has been cancelled
Tests / PHP 7.4 (push) Has been cancelled
Tests / PHP 8.0 (push) Has been cancelled
Tests / Code Style (push) Has been cancelled
Sync Wiki / Sync Wiki to GitHub (push) Has been cancelled
Release / Build and Release (push) Has been cancelled
Some checks failed
Tests / PHP 7.0 (push) Has been cancelled
Tests / PHP 7.4 (push) Has been cancelled
Tests / PHP 8.0 (push) Has been cancelled
Tests / Code Style (push) Has been cancelled
Sync Wiki / Sync Wiki to GitHub (push) Has been cancelled
Release / Build and Release (push) Has been cancelled
This commit is contained in:
118
readme.txt
Normal file
118
readme.txt
Normal file
@ -0,0 +1,118 @@
|
||||
=== WordPress Plugin Starter Template ===
|
||||
Contributors: wpallstars, your_wp_username
|
||||
Donate link: https://www.wpallstars.com
|
||||
Tags: starter, template, boilerplate, plugin development, ai coding
|
||||
Requires at least: 5.0
|
||||
Tested up to: 6.4
|
||||
Requires PHP: 7.0
|
||||
Stable tag: 0.1.0
|
||||
License: GPL-2.0+
|
||||
License URI: https://www.gnu.org/licenses/gpl-2.0.html
|
||||
|
||||
A comprehensive starter template for WordPress plugins with best practices for AI-assisted development.
|
||||
|
||||
== Description ==
|
||||
|
||||
The WordPress Plugin Starter Template provides a solid foundation for developing WordPress plugins with AI assistance. It includes a well-structured codebase, documentation templates, and best practices to help you create high-quality WordPress plugins efficiently.
|
||||
|
||||
= Key Features =
|
||||
|
||||
* **Well-structured codebase** following WordPress coding standards
|
||||
* **Modular architecture** for easy maintenance and extension
|
||||
* **Comprehensive documentation** templates for both users and developers
|
||||
* **AI-friendly workflows** with detailed guidance for AI assistants
|
||||
* **Git integration** with GitHub and Gitea support
|
||||
* **Update mechanism** with multiple source options (WordPress.org, GitHub, Gitea)
|
||||
* **Internationalization** ready with proper text domain setup
|
||||
* **Admin interface** components for building settings pages
|
||||
|
||||
= For Developers =
|
||||
|
||||
This template is designed to be a starting point for your WordPress plugin development. It provides:
|
||||
|
||||
* A clean, well-organized file structure
|
||||
* OOP approach with namespaced classes
|
||||
* Separation of concerns (admin, core functionality)
|
||||
* Documentation templates for wiki and readme files
|
||||
* GitHub Actions workflows for automated tasks
|
||||
* AI workflow documentation for AI-assisted development
|
||||
|
||||
= Credits =
|
||||
|
||||
This template is based on the experience and best practices developed while creating the [Fix 'Plugin file does not exist' Notices](https://github.com/wpallstars/wp-fix-plugin-does-not-exist-notices) plugin.
|
||||
|
||||
== Installation ==
|
||||
|
||||
1. Download the plugin zip file
|
||||
2. Log in to your WordPress admin dashboard
|
||||
3. Go to Plugins > Add New
|
||||
4. Click the "Upload Plugin" button at the top of the page
|
||||
5. Select the zip file and click "Install Now"
|
||||
6. Activate the plugin through the 'Plugins' menu in WordPress
|
||||
|
||||
== Frequently Asked Questions ==
|
||||
|
||||
= How do I use this template? =
|
||||
|
||||
This template is meant to be a starting point for your own plugin development. You should:
|
||||
|
||||
1. Copy the template files to your new plugin directory
|
||||
2. Rename files and update namespaces to match your plugin name
|
||||
3. Update plugin headers in the main PHP file
|
||||
4. Customize the functionality to meet your specific needs
|
||||
5. Update documentation to reflect your plugin's features
|
||||
|
||||
= Is this template suitable for all types of plugins? =
|
||||
|
||||
Yes, this template provides a solid foundation for most WordPress plugins. It's designed to be flexible and can be adapted for various types of plugins, from simple utilities to complex applications.
|
||||
|
||||
= How do I contribute to this template? =
|
||||
|
||||
Contributions are welcome! Please feel free to submit a pull request or open an issue on the [GitHub repository](https://github.com/wpallstars/wp-plugin-starter-template-for-ai-coding).
|
||||
|
||||
== Screenshots ==
|
||||
|
||||
1. This is a placeholder for your plugin's screenshots. Replace with actual screenshots of your plugin in action.
|
||||
|
||||
== Changelog ==
|
||||
|
||||
= 0.1.0 =
|
||||
* Initial release with basic template structure
|
||||
* Added core plugin architecture
|
||||
* Added admin interface components
|
||||
* Added documentation templates
|
||||
* Added AI workflow documentation
|
||||
|
||||
== Upgrade Notice ==
|
||||
|
||||
= 0.1.0 =
|
||||
Initial release of the WordPress Plugin Starter Template.
|
||||
|
||||
== Development ==
|
||||
|
||||
The development of this plugin follows these principles:
|
||||
|
||||
1. **Clean Code**: Following WordPress coding standards and best practices
|
||||
2. **Modularity**: Keeping components separate and focused
|
||||
3. **Documentation**: Comprehensive documentation for both users and developers
|
||||
4. **Testing**: Thorough testing across different WordPress versions
|
||||
5. **Accessibility**: Ensuring the plugin is accessible to all users
|
||||
6. **Internationalization**: Making the plugin translatable
|
||||
|
||||
= Development Resources =
|
||||
|
||||
* [GitHub Repository](https://github.com/wpallstars/wp-plugin-starter-template-for-ai-coding)
|
||||
* [WordPress Plugin Development Handbook](https://developer.wordpress.org/plugins/)
|
||||
* [WordPress Coding Standards](https://developer.wordpress.org/coding-standards/)
|
||||
|
||||
= Contributing =
|
||||
|
||||
We welcome contributions to improve this template. Please feel free to:
|
||||
|
||||
* Report bugs or issues
|
||||
* Suggest new features or improvements
|
||||
* Submit pull requests with bug fixes or enhancements
|
||||
|
||||
== Credits ==
|
||||
|
||||
This template is maintained by [WPALLSTARS](https://www.wpallstars.com) and is based on the experience and best practices developed while creating the [Fix 'Plugin file does not exist' Notices](https://github.com/wpallstars/wp-fix-plugin-does-not-exist-notices) plugin.
|
Reference in New Issue
Block a user