Added Plugin Directory Submission Tips

Signed-off-by: Andre Wanlin <awanlin@spotify.com>
2023-11-23 13:18:13 -06:00
parent e77d833c69
commit d8133b281d
2 changed files with 21 additions and 0 deletions
@@ -25,3 +25,14 @@ iconUrl: # Used as the src attribute for your logo.
 npmPackageName: # Your npm package name E.g. '@backstage/plugin-<etc>' quotes are required
 addedDate: # The date plugin added to directory E.g. '2022-10-01' quotes are required
 ```
+
+## Submission Tips
+
+Here are a few tips to help speed up the review process when you submit your plugin:
+
+- For any icon that you use make sure you have the proper rights to use it.
+- Make sure that your package had been published on the NPM registry and that it's public.
+- Make sure your package on NPM has a link back to your code repo, this helps provide confidence that it's the right package.
+- Where possible, please use an [NPM scope](https://docs.npmjs.com/about-scopes) that matches either your Organization name or user name, this provides trust in the plugin
+- If your plugin has both a frontend and backend link the documentation to the frontend package but make sure it mentioned needing to install the backend package.
+- Where possible include a screenshot of the features in you plugin documentation, it really does help when deciding to use a plugin.