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:
39
assets/README.md
Normal file
39
assets/README.md
Normal file
@ -0,0 +1,39 @@
|
||||
# Plugin Assets
|
||||
|
||||
This directory contains assets for the plugin, including:
|
||||
|
||||
- `banner/`: Banner images for the plugin
|
||||
- `icon/`: Icon images for the plugin
|
||||
- `screenshots/`: Screenshots of the plugin in action
|
||||
|
||||
These assets are used in the plugin's WordPress.org page and in the plugin itself.
|
||||
|
||||
## Asset Requirements
|
||||
|
||||
### Banner
|
||||
|
||||
- Regular: 772x250 pixels
|
||||
- Retina: 1544x500 pixels
|
||||
- PNG or JPG format
|
||||
|
||||
### Icon
|
||||
|
||||
- Regular: 128x128 pixels
|
||||
- Retina: 256x256 pixels
|
||||
- PNG format with transparency
|
||||
|
||||
### Screenshots
|
||||
|
||||
- Should be at least 1200 pixels wide
|
||||
- PNG or JPG format
|
||||
- Should demonstrate the plugin's functionality
|
||||
|
||||
## Adding Assets
|
||||
|
||||
When adding new assets:
|
||||
|
||||
1. Place the files in the appropriate directory
|
||||
2. Update the readme.txt file to reference the new screenshots
|
||||
3. Update the WordPress.org assets if the plugin is published there
|
||||
|
||||
For more information about WordPress.org plugin assets, see the `.wordpress-org/WORDPRESS_ORG_ASSETS.md` file.
|
26
assets/banner/README.md
Normal file
26
assets/banner/README.md
Normal file
@ -0,0 +1,26 @@
|
||||
# Banner Images
|
||||
|
||||
This directory contains banner images for the plugin.
|
||||
|
||||
## Required Files
|
||||
|
||||
- `banner-772x250.png`: Regular banner image (772x250 pixels)
|
||||
- `banner-1544x500.png`: Retina banner image (1544x500 pixels)
|
||||
|
||||
## Design Guidelines
|
||||
|
||||
- Keep the design simple and focused
|
||||
- Ensure text is readable
|
||||
- Use high-quality images
|
||||
- Use consistent branding (colors, fonts, etc.)
|
||||
- Test how the banner looks at different sizes
|
||||
|
||||
## Creating Banner Images
|
||||
|
||||
1. Use a design tool like Photoshop, GIMP, or Figma
|
||||
2. Create a canvas with the correct dimensions
|
||||
3. Add your plugin name, logo, and a brief description
|
||||
4. Use colors that match your plugin's branding
|
||||
5. Export as PNG or JPG
|
||||
|
||||
For more information about WordPress.org plugin assets, see the `.wordpress-org/WORDPRESS_ORG_ASSETS.md` file.
|
26
assets/icon/README.md
Normal file
26
assets/icon/README.md
Normal file
@ -0,0 +1,26 @@
|
||||
# Icon Images
|
||||
|
||||
This directory contains icon images for the plugin.
|
||||
|
||||
## Required Files
|
||||
|
||||
- `icon-128x128.png`: Regular icon image (128x128 pixels)
|
||||
- `icon-256x256.png`: Retina icon image (256x256 pixels)
|
||||
|
||||
## Design Guidelines
|
||||
|
||||
- Keep the design simple and recognizable
|
||||
- Use a transparent background
|
||||
- Ensure the icon is visible at small sizes
|
||||
- Use consistent branding (colors, fonts, etc.)
|
||||
- Test how the icon looks at different sizes
|
||||
|
||||
## Creating Icon Images
|
||||
|
||||
1. Use a design tool like Photoshop, GIMP, or Figma
|
||||
2. Create a canvas with the correct dimensions
|
||||
3. Add your plugin logo or a simple graphic that represents your plugin
|
||||
4. Use colors that match your plugin's branding
|
||||
5. Export as PNG with transparency
|
||||
|
||||
For more information about WordPress.org plugin assets, see the `.wordpress-org/WORDPRESS_ORG_ASSETS.md` file.
|
39
assets/screenshots/README.md
Normal file
39
assets/screenshots/README.md
Normal file
@ -0,0 +1,39 @@
|
||||
# Screenshots
|
||||
|
||||
This directory contains screenshots of the plugin in action.
|
||||
|
||||
## Required Files
|
||||
|
||||
- `screenshot-1.png`: First screenshot
|
||||
- `screenshot-2.png`: Second screenshot (if applicable)
|
||||
- etc.
|
||||
|
||||
## Screenshot Guidelines
|
||||
|
||||
- Screenshots should be at least 1200 pixels wide
|
||||
- Use PNG or JPG format
|
||||
- Show the plugin in action
|
||||
- Focus on one feature per screenshot
|
||||
- Use annotations to highlight important elements
|
||||
- Use real-world examples
|
||||
|
||||
## Creating Screenshots
|
||||
|
||||
1. Set up a test WordPress site with your plugin activated
|
||||
2. Configure the plugin with realistic settings
|
||||
3. Use a screen capture tool to take screenshots
|
||||
4. Edit the screenshots to add annotations if needed
|
||||
5. Save as PNG or JPG
|
||||
|
||||
## Screenshot Descriptions
|
||||
|
||||
Screenshot descriptions are added in the `readme.txt` file under the "Screenshots" section:
|
||||
|
||||
```
|
||||
== Screenshots ==
|
||||
|
||||
1. This is the first screenshot
|
||||
2. This is the second screenshot
|
||||
```
|
||||
|
||||
For more information about WordPress.org plugin assets, see the `.wordpress-org/WORDPRESS_ORG_ASSETS.md` file.
|
Reference in New Issue
Block a user