Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve plugin approval email to focus on deploying first version and following best practices. #365

Open
StevenDufresne opened this issue Sep 5, 2024 · 1 comment

Comments

@StevenDufresne
Copy link
Contributor

StevenDufresne commented Sep 5, 2024

In creating #362, I realized that there is a lot of missed opportunity in the plugin approval email to encourage users to use best practices from day one. Many of these best practices are important because failing to follow them makes it harder for these users to adopt important security features like Release Confirmations.

This is a proposal to update the approval email more holistically and provide an easy to read almost step by step guide for users to follow.


Congratulations! Your plugin, {plugin}, has been approved and is now live on the WordPress Plugin Directory.

Here's What You Need to Do Next:

Access Your SVN Repository

Your account ({username}) will be granted commit access to your Subversion (SVN) repository within the next hour.

Upload Your Code

Once access is active, upload your code to /trunk using SVN.

If you're new to SVN, or need a refresher, check out How to Use Subversion with the WordPress Plugin Directory.

Deploy your code

Use the /tags folder to deploy your code. Follow these steps:

  • Commit your code to the trunk directory, which is where the development version of your plugin lives.
  • Update the Stable Tag field in your readme.txt to match the new version (e.g., Stable Tag: 1.0).
  • Copy your code to the /tags/ directory using the command svn copy trunk tags/{version} to create versioned releases (e.g., svn copy trunk tags/1.0).
  • Done, you code is live!

Prepare Your Plugin Assets

Make sure your plugin makes a great first impression in the directory.

Note: It may take up to 72 hours for your plugin to fully appear in search results.

You’re All Set!

Ensure your plugin stays compliant with the latest guidelines and if reach out if you need additional support!

@frantorres
Copy link

Thanks for the proposal, I'm going to rephrase some parts having in mind the typical doubts the review team see from plugin authors.


Congratulations! Your plugin, {plugin}, has been approved and is now ready to be live on the WordPress Plugin Directory.

Here's what you need to do next:

Your SVN repository for this plugin

Your account ({username}) will be granted commit access to your Subversion (SVN) repository within the next hour.

Your SVN credentials

If this is the first time you use SVN or don't have your credentials at hand, you can set up your SVN credentials in the “Account & Security” section of your WordPress.org profile.

Remember:

  • Your username is case sensitive. Don't use your email address as username.
  • Your password is autogenerated, you cannot create a custom password for SVN access.
  • These same credentials will give you access to any other SVN repository on WordPress.org that your username has been granted access to.

Upload and Deploy your code

You must use SVN to upload and update your code -- we are unable to do that for you.

If you're new to SVN, or need a refresher, check out How to Use Subversion with the WordPress Plugin Directory.

Once access is active, in general terms, this is what you would need to do to upload or update your plugin:

  • Make sure you have set the Stable Tag field in your Readme file.
  • Make sure you have set the Version field in your plugin headers.
  • Make sure the version declared in the Stable Tag and Version fields are exactly the same.
  • Upload your code to /trunk using SVN.
  • Copy your code to the /tags/{version} directory to create the release for that version. You can do that using the command svn copy trunk tags/{version}. Change {version} with exactly the same version you have set up in your Stable Tag and Version fields.

For example:

  • Stable tag: 1.0 at readme.txt
  • Version: 1.0 at your plugin headers.
  • 1.0 is exactly the same to 1.0
  • Uploaded code to /trunk directory at SVN
  • Copied the code to the /tags/1.0 directory at SVN. This can be done using the command svn copy trunk tags/1.0

After doing this, wait for a few minutes and done, you code is live!

If your code is not visible after this, please check again that you are setting up exactly the same version in the Stable Tag and Version fields and as {version} in the /tags/{version} directory. If there was a mistake there, an easy way to fix it is to change the version to a higher one and redo the process.

Directory options

Configure its appearance in the directory

Make sure your plugin makes a great first impression in the directory.

Note: It may take up to 72 hours for your plugin to fully appear in search results.

Admin tools

After it is published, you can go to the "Advanced" section of your plugin page to:

  • Add "Committers" or "Support Reps" to your plugin.
  • Activate release confirmations.
  • Toggle Live Preview of your plugin.
  • Transfer or close your plugin.

You’re All Set!

Make sure your plugin complies with the latest guidelines and is secure while it's hosted in the directory.

If you have issues or questions, please reply to this email and let us know.

Enjoy!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants