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

This commit is contained in:
2025-04-18 03:09:39 +01:00
commit c7b590870c
46 changed files with 3198 additions and 0 deletions

65
.wordpress-org/README.md Normal file
View File

@ -0,0 +1,65 @@
# WordPress.org Plugin Assets
This directory contains assets for the WordPress.org plugin repository. These assets are not included in the plugin itself but are used for the plugin's WordPress.org page.
## Directory Structure
- `assets/`: Contains images and other assets for the WordPress.org plugin page
- `banner-772x250.png`: Banner image for the plugin page (772x250 pixels)
- `banner-1544x500.png`: Retina banner image (1544x500 pixels)
- `icon-128x128.png`: Icon for the plugin (128x128 pixels)
- `icon-256x256.png`: Retina icon (256x256 pixels)
- `screenshot-1.png`: First screenshot
- `screenshot-2.png`: Second screenshot (if applicable)
- etc.
## Asset Requirements
### Banner
- Regular: 772x250 pixels
- Retina: 1544x500 pixels
- PNG or JPG format
- The banner should be visually appealing and represent the plugin's purpose
### Icon
- Regular: 128x128 pixels
- Retina: 256x256 pixels
- PNG format with transparency
- The icon should be simple and recognizable
### Screenshots
- Should be at least 1200 pixels wide
- PNG or JPG format
- Should demonstrate the plugin's functionality
- Should be clear and easy to understand
## WordPress.org Plugin Submission
When submitting a plugin to WordPress.org, you need to:
1. Create a plugin ZIP file without the `.wordpress-org` directory
2. Upload the ZIP file to WordPress.org
3. Upload the assets separately through the WordPress.org plugin repository interface
For more information, see [WORDPRESS_ORG_SUBMISSION.md](WORDPRESS_ORG_SUBMISSION.md).
## Asset Design Guidelines
- Use consistent branding (colors, fonts, etc.)
- Keep the design simple and focused
- Ensure text is readable
- Use high-quality images
- Test how assets look on different devices and screen sizes
## Updating Assets
When updating assets:
1. Replace the files in this directory
2. Upload the new assets to WordPress.org through the plugin repository interface
3. It may take some time for the changes to appear on WordPress.org
For more information about WordPress.org plugin assets, see [WORDPRESS_ORG_ASSETS.md](WORDPRESS_ORG_ASSETS.md).

View File

@ -0,0 +1,83 @@
# WordPress.org Plugin Assets Guide
This document provides detailed information about the assets required for the WordPress.org plugin repository.
## Required Assets
### Banner
The banner is displayed at the top of your plugin's page on WordPress.org.
- **Regular Banner**: 772x250 pixels
- **Retina Banner**: 1544x500 pixels
- **Format**: PNG or JPG
- **File Names**: `banner-772x250.{png|jpg}` and `banner-1544x500.{png|jpg}`
### Icon
The icon is displayed next to your plugin's name in search results and on your plugin's page.
- **Regular Icon**: 128x128 pixels
- **Retina Icon**: 256x256 pixels
- **Format**: PNG with transparency
- **File Names**: `icon-128x128.png` and `icon-256x256.png`
### Screenshots
Screenshots are displayed in the "Screenshots" tab on your plugin's page.
- **Size**: At least 1200 pixels wide
- **Format**: PNG or JPG
- **File Names**: `screenshot-1.{png|jpg}`, `screenshot-2.{png|jpg}`, etc.
- **Description**: Screenshot descriptions are added in the `readme.txt` file under the "Screenshots" section
## Asset Design Best Practices
### Banner Design
- **Keep it Simple**: Don't overcrowd the banner with too much information
- **Consistent Branding**: Use colors and fonts that match your plugin's branding
- **Readable Text**: Ensure any text is large enough to read
- **Purpose**: Clearly communicate what your plugin does
- **Avoid Small Details**: Small details may not be visible at the displayed size
### Icon Design
- **Simple and Recognizable**: The icon should be simple and easily recognizable
- **Consistent with Banner**: Use similar colors and style as your banner
- **Works at Small Sizes**: Ensure the icon is recognizable even at small sizes
- **Transparent Background**: Use a transparent background for the PNG
### Screenshot Best Practices
- **Show Key Features**: Showcase the most important features of your plugin
- **Logical Order**: Arrange screenshots in a logical order that tells a story
- **Clear and Focused**: Each screenshot should focus on a specific feature
- **Annotations**: Consider adding annotations to highlight important elements
- **Real-World Examples**: Show the plugin in action with real-world examples
## Uploading Assets
Assets are uploaded separately from your plugin code:
1. Log in to your WordPress.org account
2. Navigate to your plugin's page
3. Click on the "Assets" tab
4. Upload your assets using the provided interface
## Asset Updates
When updating assets:
1. Prepare the new assets following the guidelines above
2. Log in to your WordPress.org account
3. Navigate to your plugin's page
4. Click on the "Assets" tab
5. Upload the new assets
6. It may take some time for the changes to appear on WordPress.org
## Additional Resources
- [WordPress Plugin Developer Handbook](https://developer.wordpress.org/plugins/)
- [WordPress Plugin Directory Guidelines](https://developer.wordpress.org/plugins/wordpress-org/detailed-plugin-guidelines/)
- [WordPress Plugin Assets](https://developer.wordpress.org/plugins/wordpress-org/plugin-assets/)

View File

@ -0,0 +1,120 @@
# WordPress.org Plugin Submission Guide
This document provides a step-by-step guide for submitting your plugin to the WordPress.org plugin repository.
## Before Submission
### 1. Prepare Your Plugin
- Ensure your plugin follows the [WordPress Plugin Guidelines](https://developer.wordpress.org/plugins/wordpress-org/detailed-plugin-guidelines/)
- Check that your plugin meets the [Plugin Directory Requirements](https://developer.wordpress.org/plugins/wordpress-org/plugin-developer-faq/)
- Verify that your plugin follows WordPress coding standards
- Test your plugin thoroughly on different WordPress versions
### 2. Prepare Required Files
- **readme.txt**: Create a readme.txt file following the [WordPress readme.txt standard](https://developer.wordpress.org/plugins/wordpress-org/how-your-readme-txt-works/)
- **Plugin Header**: Ensure your main plugin file includes the required plugin header
- **License**: Include the GPL v2 or later license
- **Assets**: Prepare banner, icon, and screenshots (see [WORDPRESS_ORG_ASSETS.md](WORDPRESS_ORG_ASSETS.md))
### 3. Create a Clean Build
- Remove any development files (e.g., .git, node_modules, etc.)
- Remove any unnecessary files (e.g., .DS_Store, Thumbs.db, etc.)
- Create a ZIP file of your plugin
## Submission Process
### 1. Create a WordPress.org Account
If you don't already have one, create an account on [WordPress.org](https://wordpress.org/).
### 2. Submit Your Plugin
1. Go to the [Add Your Plugin](https://wordpress.org/plugins/developers/add/) page
2. Fill out the submission form:
- Plugin Name
- Plugin URL (optional)
- Description
- Upload your plugin ZIP file
3. Agree to the terms and submit your plugin
### 3. Wait for Review
- The WordPress.org team will review your plugin
- This process can take several weeks
- You'll receive an email when your plugin is approved or if there are issues to address
### 4. Address Review Feedback
If the WordPress.org team provides feedback:
1. Make the requested changes
2. Create a new ZIP file
3. Reply to the review email with the changes you've made
4. Attach the updated ZIP file or provide a link to download it
### 5. Upload Assets
Once your plugin is approved:
1. Log in to your WordPress.org account
2. Navigate to your plugin's page
3. Click on the "Assets" tab
4. Upload your banner, icon, and screenshots
## After Approval
### 1. Set Up SVN Access
WordPress.org uses Subversion (SVN) for plugin management:
1. You'll receive SVN access details via email
2. Set up SVN on your local machine
3. Check out your plugin repository
### 2. Manage Your Plugin with SVN
Basic SVN commands for managing your plugin:
```bash
# Check out your plugin repository
svn checkout https://plugins.svn.wordpress.org/your-plugin-name/
# Add new files
svn add new-file.php
# Commit changes
svn commit -m "Description of changes"
# Update your local copy
svn update
```
### 3. Release Updates
To release a new version:
1. Update the version number in your plugin file and readme.txt
2. Update the changelog in readme.txt
3. Test the new version thoroughly
4. Commit the changes to the `trunk` directory
5. Tag the new version:
```bash
svn copy https://plugins.svn.wordpress.org/your-plugin-name/trunk https://plugins.svn.wordpress.org/your-plugin-name/tags/1.0.1 -m "Tagging version 1.0.1"
```
## Best Practices
- **Respond Promptly**: Respond to review feedback promptly
- **Be Patient**: The review process can take time
- **Be Thorough**: Test your plugin thoroughly before submission
- **Follow Guidelines**: Adhere to all WordPress.org guidelines
- **Maintain Your Plugin**: Regularly update your plugin to fix bugs and add features
## Additional Resources
- [WordPress Plugin Developer Handbook](https://developer.wordpress.org/plugins/)
- [WordPress Plugin Directory Guidelines](https://developer.wordpress.org/plugins/wordpress-org/detailed-plugin-guidelines/)
- [WordPress Plugin Developer FAQ](https://developer.wordpress.org/plugins/wordpress-org/plugin-developer-faq/)