Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. Weโ€™ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add community PR process documentation #471

Merged
merged 3 commits into from
Nov 13, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 64 additions & 0 deletions docs/contributing/pull-requests/community-pr-process.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
---
sidebar_position: 4
sidebar_custom_props:
access: community
---

# Contribution Review Process

Congratulations! You've submitted a pull request for changes to the Bitwarden codebase.

Bitwarden recognizes the time and effort that community members take to recognize bugs or potential
new features and offer up pull requests to resolve them.

Transparency is one of our core values, and we feel that it is important that contributors
understand the process that our teams take in evaluating, prioritizing, and reviewing these pull
requests, and why some changes may move more quickly to completion than others.

## Product assessment

When your community contribution is received, the first step is for our Product team to evaluate
whether the change aligns with the vision for the Bitwarden product. This is more relevant for
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
whether the change aligns with the vision for the Bitwarden product. This is more relevant for
whether the change aligns with the vision for the Bitwarden products. This is more relevant for

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Addressed with 539ba43 (#471).

feature enhancements than bugs, but it is important for us to assess whether the change conflicts
with larger upcoming changes on the roadmap or would potentially replace work already on the backlog
for a team.

If the Product team has clarifying questions or would like the change to be modified to more closely
align with their vision, they will reach out on the PR and request changes.

Once Product has signed off on the change, it moves to our Engineering teams.

## Engineering assessment

The Engineering team(s) responsible for the change depend largely on what code was changed. We use
Github code owners to manage the areas in our repositories owned by each team, and the responsible
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Github code owners to manage the areas in our repositories owned by each team, and the responsible
GitHub code owners to manage the areas in our repositories owned by each team, and the responsible

Copy link
Member Author

@trmartin4 trmartin4 Nov 12, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Addressed with 539ba43 (#471)

team(s) will be automatically tagged as reviewers on the PR that you raise to merge your changes.

:::tip Assigned reviewers

When a Bitwarden developer is assigned to your PR, that does not necessarily mean that the PR is
under active review at that moment. This assignment may take place while the work is still on the
team's backlog.

:::

The responsible Engineering teams will review the change and ensure that there are no concerns
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The responsible Engineering teams will review the change and ensure that there are no concerns
The responsible Engineering team(s) will review the change and ensure that there are no concerns

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Addressed with 539ba43 (#471).

around how the change was implemented. This is generally more applicable for larger sets of changes,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
around how the change was implemented. This is generally more applicable for larger sets of changes,
around how the change was implemented; this is generally more applicable for larger sets of changes,

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Addressed with 539ba43 (#471).

where the team needs to ensure that the change aligns with the architectural vision for how the code
should be structured. Community contributors following practices exhibited in the current codebase
may not be aware of existing tech debt or patterns that are no longer encouraged for new
development. Intervening at this point allows us to communicate to you preemptively and request the
desired changes before a formal review starts.

## Pull request review and testing

Once the team has assessed the high-level implementation, your contribution is ready for active code
review. If not done already, the PR will be assigned to a Bitwarden engineer from each responsible
team.

The reviewer and the team's QA engineers will test the change in all applicable clients or server
environments and ensure that proper test coverage is present. If there are changes required, or
testing is not successful, they will reach out on the PR to request changes.

Once that is complete, they will approve the changes and contact you on the PR to let you know. They
will merge your PR into the `main` branch, and it will be included in the next release!
5 changes: 2 additions & 3 deletions docs/contributing/pull-requests/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,9 +152,8 @@ pull request, the author should reach out to the reviewing team via their Slack

<Community>

Once a Community PR has been created a Bitwarden developer will perform a code review. While we try
to this in a reasonable time frame, please understand that we have internal roadmaps and priorities
that may delay this process.
When your pull request is received, it will follow our
[community contribution review process](community-pr-process.md).

</Community>

Expand Down