Consolidate asset files and improve WordPress.org submission guide (v1.6.25)
Some checks failed
ci/woodpecker/push/woodpecker Pipeline is pending
Build Release / Build and Create Release (push) Has been cancelled
Build Release / Deploy to WordPress.org (push) Has been cancelled
ci/woodpecker/tag/woodpecker Pipeline failed

This commit is contained in:
2025-04-12 19:21:09 +01:00
parent 17d3d0946a
commit 8f5acd3031
15 changed files with 133 additions and 20 deletions

View File

@ -0,0 +1,96 @@
# WordPress.org Plugin Submission Assets Guide
This document explains how to prepare and upload assets for WordPress.org plugin submission.
## WordPress.org SVN Repository Structure
When submitting a plugin to WordPress.org, you'll work with an SVN repository that has this structure:
```
/assets/ # Contains assets for the WordPress.org plugin page
icon-256x256.png
icon-128x128.png
banner-772x250.png
banner-1544x500.png
screenshot-1.png
screenshot-2.png
screenshot-3.png
/tags/ # Contains tagged releases
/1.0.0/
[plugin files]
/1.0.1/
[plugin files]
/trunk/ # Contains the current version of the plugin
[plugin files]
```
## Asset Requirements
### Icon
- **Format**: PNG
- **Sizes**:
- Required: 256x256 pixels (`icon-256x256.png`)
- Optional: 128x128 pixels (`icon-128x128.png`)
- **Location**: Upload to the `/assets/` directory in the WordPress.org SVN repository
- **Status**: ✅ READY - Files are in `assets/icon/`
### Banner
- **Format**: PNG
- **Sizes**:
- Required: 772x250 pixels (`banner-772x250.png`)
- Optional: 1544x500 pixels (`banner-1544x500.png`) for high-DPI displays
- **Location**: Upload to the `/assets/` directory in the WordPress.org SVN repository
- **Status**: ✅ READY - Files are in `assets/banner/`
### Screenshots
- **Format**: PNG
- **Naming**: Sequential numbers (`screenshot-1.png`, `screenshot-2.png`, etc.)
- **Location**: Upload to the `/assets/` directory in the WordPress.org SVN repository
- **Status**: ⚠️ PARTIALLY READY
- `screenshot-1.png` is available in `assets/screenshots/`
- Need to create `screenshot-2.png` and `screenshot-3.png` to match readme.txt descriptions
## Submission Process
1. **Prepare Plugin Files**:
- Ensure all plugin files are ready in your local repository
- Make sure version numbers are consistent across all files
2. **Prepare Assets**:
- Ensure all assets follow the naming conventions above
- Verify that screenshots match the descriptions in readme.txt
3. **Upload to WordPress.org**:
- When you receive SVN access, use these commands:
```bash
# Check out the repository
svn checkout https://plugins.svn.wordpress.org/fix-plugin-does-not-exist-notices/
# Copy plugin files to trunk
cp -r [your-local-plugin-files]/* fix-plugin-does-not-exist-notices/trunk/
# Copy assets to assets directory
cp assets/icon/icon-256x256.png fix-plugin-does-not-exist-notices/assets/
cp assets/icon/icon-128x128.png fix-plugin-does-not-exist-notices/assets/
cp assets/banner/banner-772x250.png fix-plugin-does-not-exist-notices/assets/
cp assets/banner/banner-1544x500.png fix-plugin-does-not-exist-notices/assets/
cp assets/screenshots/screenshot-1.png fix-plugin-does-not-exist-notices/assets/
cp assets/screenshots/screenshot-2.png fix-plugin-does-not-exist-notices/assets/
cp assets/screenshots/screenshot-3.png fix-plugin-does-not-exist-notices/assets/
# Add new files
cd fix-plugin-does-not-exist-notices
svn add --force trunk/*
svn add --force assets/*
# Commit changes
svn commit -m "Initial plugin submission"
```
## Resources
- [WordPress Plugin Developer Handbook - Plugin Assets](https://developer.wordpress.org/plugins/wordpress-org/plugin-assets/)
- [WordPress Plugin Directory README.txt Standard](https://developer.wordpress.org/plugins/wordpress-org/how-your-readme-txt-works/)

View File

@ -8,4 +8,4 @@ For WordPress.org plugin submission, you need:
- `banner-1544x500.png` (for high-resolution/retina displays)
3. Place them in the root of your SVN assets directory
These files have been properly renamed from the original files to match WordPress.org requirements.
These files have been renamed from the original files to match WordPress.org's naming-convention and file format requirements.

View File

Before

Width:  |  Height:  |  Size: 38 KiB

After

Width:  |  Height:  |  Size: 38 KiB

View File

Before

Width:  |  Height:  |  Size: 15 KiB

After

Width:  |  Height:  |  Size: 15 KiB

View File

@ -3,8 +3,8 @@
For WordPress.org plugin submission, you need to:
1. Convert the SVG icon to PNG format
2. Create a 256x256 pixel version
3. Name it `icon-256x256.png`
2. Create a 256x256 and 128x128 pixel version
3. Name them `icon-256x256.png` and `icon-128x128.png`
4. Place it in the root of your SVN assets directory
## How to Convert
@ -12,7 +12,11 @@ For WordPress.org plugin submission, you need to:
You can use tools like:
- Inkscape (free, open-source)
- Adobe Illustrator
- Adobe Photoshop
- Affinity Designer
- Affinity Photo
- GIMP
- Pixelmator
- Online converters like https://svgtopng.com/
## Command Line Conversion (if you have ImageMagick installed)

View File

Before

Width:  |  Height:  |  Size: 1.8 KiB

After

Width:  |  Height:  |  Size: 1.8 KiB

View File

Before

Width:  |  Height:  |  Size: 2.7 KiB

After

Width:  |  Height:  |  Size: 2.7 KiB

View File

Before

Width:  |  Height:  |  Size: 30 KiB

After

Width:  |  Height:  |  Size: 30 KiB

View File

@ -4,15 +4,4 @@ For WordPress.org plugin submission, you need:
1. Screenshots in PNG format
2. Named sequentially: `screenshot-1.png`, `screenshot-2.png`, etc.
3. Place them in the root of your SVN assets directory
## Important Note
The readme.txt file references 3 screenshots:
1. Error message with explanation notification
2. Missing plugin shown in the plugins list with "Remove Notice" link
3. Auto-scroll feature that highlights the missing plugin
However, only one screenshot file is currently available. You need to create and add the other two screenshots to match the descriptions in the readme.txt file.
After creating all three screenshots with the proper naming convention, they should be uploaded to the WordPress.org SVN repository in the assets directory.
3. Place them in the root of your SVN assets directory

View File

Before

Width:  |  Height:  |  Size: 392 KiB

After

Width:  |  Height:  |  Size: 392 KiB