backstage / backstage/backstage

🙏 Help Wanted: Become a Backstage Reviewer

Open
#32,794 24 comments 19 reactions 0 assignees View on GitHub
priority:roadmap
Dominant language
TypeScript
Stars
34.4k
Forks
7.6k
Avg merge
8h 57m
Merged PRs (30d)
50

Description

We have just launched a new [Pull Request Review workflow](https://github.com/backstage/backstage/blob/master/REVIEWING.md#review-workflow) for the Backstage project. This workflow was designed with reviewers in mind from the start, to find a way for members of the community to be able to contribute in a meaningful way. The new process is centered around a prioritized review board where high priority pull requests have the greatest visibility. It is also designed around a reviewer group that only has read access to the repository, but can still approve and request changes in a way that substantially impacts pull requests.

## Why become a reviewer?

Being a reviewer is a great way to get more involved in the Backstage project. It is an opportunity to help the project, and in doing so also grow your own skills both through the process of reviewing and also getting feedback on those reviews from maintainers. As a reward for your efforts, your own pull requests will also be prioritized higher.

As a member of `@backstage/reviewers`, your reviews have real impact on how pull requests move forward. When you approve a pull request, it receives the `reviewer-approved` label, which significantly boosts its priority on the review board and its visibility for project area maintainers. When you request changes, the pull request is moved out of the review queue until the author responds, helping keep the queue focused on PRs that are actually ready. The more pull requests you review, the higher your own pull requests are prioritized on the review board, a thank-you for helping out.

## How does it work?

The process for reviewers is detailed in the [Reviewing](https://github.com/backstage/backstage/blob/master/REVIEWING.md#review-process-for-backstagereviewers) document. Some important aspects to consider during reviews are also listed there, such as best practices for [Changesets](https://github.com/backstage/backstage/blob/master/REVIEWING.md#changesets), [Code Style](https://github.com/backstage/backstage/blob/master/REVIEWING.md#code-style), [Configuration](https://github.com/backstage/backstage/blob/master/REVIEWING.md#configuration), and [Secure Coding Practices](https://github.com/backstage/backstage/blob/master/REVIEWING.md#secure-coding-practices). Reviewers have access to the new review board, but are not required to use it. You can also pick [pull requests directly from the repo](https://github.com/backstage/backstage/pulls) that you think are important, interesting, or fit your areas of expertise.

There is no pressure to get pull requests in perfect shape before approving them either. If you have provided the feedback on a pull request and the author has addressed your comments, you can approve the pull request with a comment explaining the areas you are unsure about. The review process is intended to be a collaboration between the author, reviewers, and maintainers.

Our only ask is to not submit spammy reviews, such as systematically approving pull requests that have already been approved by other reviewers. We want to keep this fair for all reviewers and will consider removing reviewers that are found to be abusing the system.

## How do I join?

If you're already an organization member and a long time contributor, just leave a comment on this issue letting us know that you want to be a reviewer and we'll add you to the `@backstage/reviewers` group. If you're not yet an org member, the [Backstage Governance](https://github.com/backstage/community/blob/main/GOVERNANCE.md) document has everything you need to know about the simple steps to become an Organization Member and Reviewer.

## What if I don't have enough time?

That's totally fine! There's no minimum commitment. Review when you can, every review helps, both the project and your own priority boost.

Contributor guide

Open the contributing guide

Research direction

Read REVIEWING.md at the review workflow and reviewer process sections, then check the Backstage Governance document for organization-member requirements. Leave a comment on this issue requesting reviewer access if eligible; completion means being added to the @backstage/reviewers group.

Written by the indexing model from the issue text.

Assessment

Tech stack
github
Domain
developer-experience
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Active
Clarity
Clearly specified
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.