Skip to content

Commit 3b26ff1

Browse files
authored
doc: clarify organization membership flow and expectations for adding CODEOWNERS (#3472)
This PR updates the documentation to match the new organization membership request process and issue template. It now clearly states that all BCP maintainers must support plugin-related organization membership requests. It also clarifies that adding new CODEOWNERS requires agreement from the existing owners and some evidence of contribution to the plugin. These changes aim to make expectations clearer and help reduce the backlog of pending organization membership requests. Signed-off-by: Beth Griggs <bethanyngriggs@gmail.com>
1 parent 0d59491 commit 3b26ff1

File tree

1 file changed

+10
-19
lines changed

1 file changed

+10
-19
lines changed

CONTRIBUTING.md

Lines changed: 10 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,11 @@ If you have questions or feedback regarding Community Plugins, you can visit the
2020
- [Release](#release)
2121
- [Creating a new Workspace](#creating-a-new-workspace)
2222
- [Creating new plugins or packages in a Workspace](#creating-new-plugins-or-packages-in-a-workspace)
23+
- [Local development of plugins](#local-development-of-plugins)
2324
- [Migrating a plugin](#migrating-a-plugin)
2425
- [Manual migration steps](#manual-migration-steps)
2526
- [Organization Membership Request for CODEOWNERS](#organization-membership-request-for-codeowners)
27+
- [Adding Additional CODEOWNERS](#adding-additional-codeowners)
2628
- [Developer Certificate of Origin](#developer-certificate-of-origin)
2729
- [API Reports](#api-reports)
2830
- [Submitting a Pull Request](#submitting-a-pull-request)
@@ -235,34 +237,23 @@ Visit the [Package Metadata documentation](https://backstage.io/docs/tooling/pac
235237

236238
This section outlines the process for plugin maintainers to request organization membership in the Backstage community, which is necessary for efficiently managing `CODEOWNERS` in this repository.
237239

238-
Plugin maintainers can request organization membership by submitting a request through [this link](https://github.com/backstage/community/issues/new/choose) and filling out the provided form. In the request, they should:
240+
Plugin maintainers can request organization membership by submitting a request through [this link](https://github.com/backstage/community/issues/new/choose) and filling out the provided form. In the request:
239241

240-
- List the plugins they have contributed and/or maintain within the 'Highlighted Contributions' section.
242+
- If you are requesting membership after migrating a plugin into this repository, include a link to the PR that performed the migration.
243+
- List the plugins you have contributed to and/or maintain.
241244
- Ping the [Community Plugins Area Maintainers](https://github.com/backstage/community/tree/main/project-areas/community-plugins#community-plugin-area-maintainers) for review and support of the request.
242245

243-
As becoming an organization member provides elevated permissions, addition of new organization members follows a vetting process, while hoping not to create unnecessary barriers for new plugin maintainers. The following criteria are often used for the vetting process:
244-
245-
- Is the individual a member of other teams in Backstage?
246-
- What is the length and consistency of their involvement with Backstage plugins and/or the Backstage community?
247-
- Are there other contributors or plugin maintainers who work with the individual and can vouch for them?
248-
- Do they have an employer with a vested interest in the Backstage community?
249-
250246
The Community Plugins Area Maintainers will review the request. While the request is being processed, plugin maintainers are encouraged to review and approve PRs related to their plugins, even though it will not yet show up as a formal review in the GitHub UI.
251247

252-
**Form Details:**
248+
Open requests will be routinely reviewed during Community Plugins SIG meetings. Community Plugin Area Maintainers must indicate support before a request is approved. Once approved, a Backstage organization admin will carry out the membership action.
253249

254-
- **Name**: Organization Membership Request
255-
- **Description**: A request to become a Backstage organization member
256-
- **Title**: Org Member: `<your-github-login>`
257-
- **Labels**: `org-member-request`
250+
### Adding Additional CODEOWNERS
258251

259-
The form includes fields to confirm adherence to the Code of Conduct, list highlighted contributions, and more. Please ensure you provide:
252+
New individuals can be added to a plugin’s `CODEOWNERS` entry to help support reviews, issue triage, and ongoing maintenance. To propose an addition, open a PR that updates the plugin's entry in the `CODEOWNERS` file and include a brief justification along with links to relevant contributions (such as authored PRs, reviews, or issue triage).
260253

261-
1. The plugins you maintain within the community plugins section.
262-
2. Links to your notable contributions (PRs, issues, etc.).
263-
3. A list of other plugin maintainers who can vouch for your request.
254+
Agreement from the existing `CODEOWNERS` of the plugin is required before the change is approved.
264255

265-
Once the form is submitted, the plugin maintainers will review your request and provide feedback or support as needed.
256+
Ideally, proposed codeowners have already been actively involved with the plugin. Providing this evidence also helps build a foundation for future organization membership requests.
266257

267258
## Developer Certificate of Origin
268259

0 commit comments

Comments
 (0)