Skip to content

Commit f4a345e

Browse files
committed
docs: add plugin creation tips to CONTRIBUTING.md
Signed-off-by: Hope Hadfield <[email protected]>
1 parent 01db07a commit f4a345e

File tree

1 file changed

+23
-2
lines changed

1 file changed

+23
-2
lines changed

CONTRIBUTING.md

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -269,13 +269,34 @@ Each plugin/package has its own API Report which means you might see more than o
269269

270270
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.
271271
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+
272293
> [!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.
274295
275296
## Plugin Owner Responsibilities
276297
277298
> [!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).
279300
280301
As a plugin owner, you are responsible for the ongoing health and maintenance of your plugin(s) in this repository.
281302

0 commit comments

Comments
 (0)