You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+23-2Lines changed: 23 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -269,13 +269,34 @@ Each plugin/package has its own API Report which means you might see more than o
269
269
270
270
When you've got your contribution working, tested, and committed to your branch it's time to create a Pull Request (PR). If you are unsure how to do this GitHub's [Creating a pull request from a fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) documentation will help you with that.
271
271
272
+
For new plugins, it is recommended that your initial PR simply creates the workspace for your plugins. In this PR, be sure to add maintainers to the `CODEOWNERS` file for the new workspace. This will streamline the approval process, and also ensure that you have full autonomy over further development of your plugin.
273
+
274
+
### Checklist to Ensure your Plugin is Ready to Merge
275
+
276
+
* Workspace `package.json` contains
277
+
* `private: true`
278
+
* Correct repository url
279
+
* Few dependencies at workspace-level
280
+
* Plugin `package.json` contains
281
+
* If intending to publish
282
+
* No `private: true`
283
+
* `publishConfig.access: “public”`
284
+
* Correct `backstage` config with `role`, `pluginId`, and `pluginPackages`
285
+
* Correct repository url
286
+
* Changeset is present
287
+
* README files are present and appropriate
288
+
* `backstage.json` is present with appropriate Backstage version
289
+
* `config.d.ts` exists at package-level if plugin has configuration
290
+
* Contains proper visibility annotations
291
+
* `.github/CODEOWNERS` is up to date
292
+
272
293
> [!NOTE]
273
-
> Only [repository maintainers](https://github.com/orgs/redhat-developer/teams/rhdh-plugins-maintainers) can bypass the SonarCloud test. We typically grant a one-time exception for new plugins that require a full application instead of a standalone development server. If this applies to your pull request, please mention it in the description.
294
+
> Only [repository maintainers](https://github.com/orgs/redhat-developer/teams/rhdh-cope) can bypass the SonarCloud test. We typically grant a one-time exception for new plugins that require a full application instead of a standalone development server. If this applies to your pull request, please mention it in the description.
274
295
275
296
## Plugin Owner Responsibilities
276
297
277
298
> [!NOTE]
278
-
> To carry out your responsibilities as a plugin owner, you will need write access to the repository. If you are a plugin owner and do not have write access, please reach out to one of the [repository maintainers](https://github.com/orgs/redhat-developer/teams/rhdh-plugins-maintainers).
299
+
> To carry out your responsibilities as a plugin owner, you will need write access to the repository. If you are a plugin owner and do not have write access, please reach out to one of the [repository maintainers](https://github.com/orgs/redhat-developer/teams/rhdh-cope).
279
300
280
301
As a plugin owner, you are responsible for the ongoing health and maintenance of your plugin(s) in this repository.
0 commit comments