Skip to content

Commit 6320073

Browse files
update plugin owner expectations (#650)
* update plugin owner expectations Signed-off-by: Kashish Mittal <kmittal@redhat.com> * Update CONTRIBUTING.md Co-authored-by: Christoph Jerolimov <jerolimov@gmail.com> --------- Signed-off-by: Kashish Mittal <kmittal@redhat.com> Co-authored-by: Christoph Jerolimov <jerolimov@gmail.com>
1 parent d674136 commit 6320073

1 file changed

Lines changed: 31 additions & 20 deletions

File tree

CONTRIBUTING.md

Lines changed: 31 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,15 @@ The `redhat-developer/rhdh-plugins` repository is designed as a collaborative sp
2222
- [Next steps](#next-steps)
2323
- [Maintenance of older versions](#maintenance-of-older-versions)
2424
- [API Reports](#api-reports)
25-
- [Maintaining Plugins](#maintaining-plugins)
25+
- [Submitting a Pull Request](#submitting-a-pull-request)
26+
- [Plugin Owner Responsibilities](#plugin-owner-responsibilities)
27+
- [Responsibilities](#responsibilities)
2628
- [Keeping Workspaces Up to Date with Backstage](#keeping-workspaces-up-to-date-with-backstage)
2729
- [Process](#process)
2830
- [Updating Dependencies with Renovate](#updating-dependencies-with-renovate)
2931
- [Types of PRs](#types-of-prs)
3032
- [Dependency Updates](#dependency-updates)
3133
- [Security Fixes](#security-fixes)
32-
- [Responsibilities](#responsibilities)
33-
- [Submitting a Pull Request](#submitting-a-pull-request)
3434

3535
## License
3636

@@ -262,14 +262,38 @@ There are two ways you can do this:
262262

263263
Each plugin/package has its own API Report which means you might see more than one file updated or created depending on your changes. These changes will then need to be committed as well.
264264

265-
## Maintaining Plugins
265+
## Submitting a Pull Request
266266

267-
### Keeping Workspaces Up to Date with Backstage
267+
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.
268268
269-
To keep plugins in the various workspaces up to date with Backstage we have a [Version Bump Workflow](https://github.com/redhat-developer/rhdh-plugins/actions/workflows/version-bump.yml) in place, similar to the one that is used in the [backstage/community-plugins](https://github.com/backstage/community-plugins) repository.
269+
270+
## Plugin Owner Responsibilities
270271
271272
> [!NOTE]
272-
> To run this workflow, 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 admins (@bethgriggs, @nickboldt, @04kash).
273+
> 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).
274+
275+
As a plugin owner, you are responsible for the ongoing health and maintenance of your plugin(s) in this repository.
276+
277+
### Responsibilities
278+
279+
- **Review, approve, and merge PRs** opened against your plugin, including:
280+
- Community contributions
281+
- Renovate PRs (See [Updating Dependencies with Renovate](#updating-dependencies-with-renovate))
282+
- Dependabot PRs
283+
- Version package PRs
284+
- **Keep your workspace(s) up to date** with the latest Backstage version supported by RHDH.
285+
See [Keeping Workspaces Up to Date](#keeping-workspaces-up-to-date-with-backstage).
286+
- **Manage security updates and patches**:
287+
Work with your security team to address vulnerabilities according to SLA and product lifecycle requirements.
288+
Since this repository does not maintain release branches, Renovate only opens PRs against the latest code.
289+
If your plugin is used in multiple product versions, you are responsible for backporting critical patches.
290+
- **Justify Dependency-Related PR closures**:
291+
If you choose not to merge a Renovate or dependency-related PR, include a brief explanation when closing it.
292+
293+
294+
### Keeping Workspaces Up to Date with Backstage
295+
296+
To keep plugins in the various workspaces up to date with Backstage we have a [Version Bump Workflow](https://github.com/redhat-developer/rhdh-plugins/actions/workflows/version-bump.yml) in place, similar to the one that is used in the [backstage/community-plugins](https://github.com/backstage/community-plugins) repository.
273297
274298
#### Process
275299
@@ -301,16 +325,3 @@ This repository uses [Renovate](https://docs.renovatebot.com/) to automatically
301325
302326
- PRs can also be opened for security alerts. These PRs are distinguishable with a `[security]`suffix in its title and will also have a `security` label.
303327
304-
#### Responsibilities
305-
306-
As a plugin owner,
307-
308-
- You are responsible for reviewing, approving, and merging the PRs opened against your plugins
309-
- If you decide to not accept the Renovate fixes, provide a justification before closing.
310-
- Work with your security team to ensure vulnerabilities are fixed according to their SLA timelines and Product Lifecycle requirements.
311-
312-
Because we do not have release branches in this repo, Renovate will only create PRs against the latest code. Plugin owners will need to ensure any necessary patches are backported if their plugins are maintained in multiple product versions.
313-
314-
## Submitting a Pull Request
315-
316-
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.

0 commit comments

Comments
 (0)