[ English | 中文 (简体, 中国) | Deutsch | English (United Kingdom) | 한국어 (대한민국) | Indonesia | español (México) ]

Code Review Templates

While anyone can review code in Gerrit this document is primarly aimed at project core reviewers and maintainers.

Every code review should give the contributor a concrete path forward whether that is waiting for (or soliciting) a second reviewer to approve a change, making updates to the change to address feedback, or abandoning the change as it is not applicable. The contributor should know what to do next after reading the review(s) on their contribution.

Reviews should be direct, concise and give clear direction for the next steps. Language should be welcoming and professional. Inline comments should similarly be as direct and clear as possible. Use of Gerrit’s «Suggest Edit» tool can further avoid ambiguity.

The following review templates in this appendix aim to serve as examples that can be used directly in the code review process with minimal edits.

+2

Without Approval

Thank you for your contribution. This change looks good to me. It needs one
more core reviewer to sign off and approve the change before it can be
merged.

If that second review is delayed you can reach us at these locations:
IRC: OFTC #openstack-example
Email: openstack-discuss@lists.openstack.org
Weekly Team Meeting: OFTC #[CHANNEL_NAME] at [UTC TIME] [DAY]

With Approval

Thank you for your contribution. This change looks good to me, and I have
approved it. Zuul will test it one more time, and if those gate tests pass
the change should be automatically merged by Zuul. You can follow along at
https://zuul.opendev.org/t/openstack/status

If the change does not merge as expected you can reach out to us at these
locations:
IRC: OFTC #openstack-example
Email: openstack-discuss@lists.openstack.org
Weekly Team Meeting: OFTC #[CHANNEL_NAME] at [UTC TIME] [DAY]

+1

Thank you for your contribution. This change looks good to me. I am not
applying a +2 vote because [GIVE REASON HERE]. Other core reviewers, more
familiar with this area of code, will need to review the change and apply
their +2 votes and approvals.

If additional review is delayed you can reach us at these locations:
IRC: OFTC #openstack-example
Email: openstack-discuss@lists.openstack.org
Weekly Team Meeting: OFTC #[CHANNEL_NAME] at [UTC TIME] [DAY]

Example

Thank you for your contribution. This change looks good to me. I am not
applying a +2 vote because I am unfamiliar with this particular driver and
its behaviors. Other core reviewers, more familiar with this area of code,
will need to review the change and apply their +2 votes and approvals.

If additional review is delayed you can reach us at these locations:
IRC: OFTC #openstack-example
Email: openstack-discuss@lists.openstack.org
Weekly Team Meeting: OFTC #[CHANNEL_NAME] at [UTC TIME] [DAY]

-1

Thank you for your contribution. This change requires improvement before it
can be merged into the code base. Please refer to the inline comments for
specific feedback. It is possible that other reviewers may have additional
feedback, and that we may need to go through several iterations before we
achieve consensus on the change and merge it.

Please push a new patchset with updates addressing this feedback or followup
with additional questions on this change. Ideally we will keep discussion in
Gerrit comments so that everyone following this change can maintain a common
context.

If followup reviews after updates are delayed you can reach us at these
locations:
IRC: OFTC #openstack-example
Email: openstack-discuss@lists.openstack.org
Weekly Team Meeting: OFTC #[CHANNEL_NAME] at [UTC TIME] [DAY]

-2

Thank you for your contribution. Unfortunately, this particular change is
not appropriate for the project at this time. [GIVE REASON HERE].

We appreciate your contribution, and if you have any questions about the
project direction and priorities please reach out to us for further
discussion. We can be reached at the following locations:
IRC: OFTC #openstack-example
Email: openstack-discuss@lists.openstack.org
Weekly Team Meeting: OFTC #[CHANNEL_NAME] at [UTC TIME] [DAY]

Example

Thank you for your contribution. Unfortunately, this particular change is
not appropriate for the project at this time. This change relies on a
library that is not licensed in a compatible way with our project. All
changes to our project must be Open Source and compatible with the Apache 2
software license.

We appreciate your contribution, and if you have any questions about the
project direction and priorities please reach out to us for further
discussion. We can be reached at the following locations:
IRC: OFTC #openstack-example
Email: openstack-discuss@lists.openstack.org
Weekly Team Meeting: OFTC #[CHANNEL_NAME] at [UTC TIME] [DAY]

New Changes

A welcoming response to be posted on new changes before propper review happens. This may be applied manually or automatically through the use of tools.

Template

Thank you for submitting your change for review.

Please be mindful that it can take some time for reviewers to get to your
change, and we appreciate your patience.

Please check [PRIORITY TRACKING TOOL/METHOD] to get a better understanding
of our team’s current priorities and workload.

While you are waiting, you can help our team to increase its bandwidth by:
- Offsetting the reviewer resources spent on your patch by reviewing
other patches
- [ADD MORE IDEAS HERE IF APPLICABLE]

If your change hasn’t been reviewed by anyone for more than
[TIME PERIOD, ie: 1 week], please reach out to our team at any of the
following locations:
IRC: OFTC #openstack-example
Email: openstack-discuss@lists.openstack.org
Weekly Team Meeting: OFTC #[CHANNEL_NAME] at [UTC TIME] [DAY]

As your change goes through the review process, please remember to treat
maintainers and fellow contributors with respect.