Quick tips for code reviews

[Sergio Pena <se...@cloudera.com>]

Hey All,

I just want to share with the community about some helpful tips when
submitting patches for review that are useful for reviewers:

   - Add a link to the review board on the JIRA related to the patch you're
   working on.
   - Add a link to the JIRA on the review board related to the patch you're
   working on (Add the JIRA in the Bugs field).

These extra steps you do when submitting a patch save reviewers time when
looking for references on the JIRA or the Review Board. For instance:

   - I miss the RB link to the patch. If I go to the JIRA, then I can find
   it and click on the link to take me to the patch (1 click) instead of
   searching the patch on the RB (takes time).
   - I want to go to the JIRA that is referenced in the RB patch. If I go
   to the Bugs field, then I can click on the link to take me to the JIRA (1
   click) instead of opening another window, go to JIRA, edit the JIRA number
   and press enter.

I encourage to use that on current and future patches to also have a
reference to the review and who review the patch.

- Sergio

Re: Quick tips for code reviews

[Na Li <li...@cloudera.com>]

+1

The most important item is to put review link to Jira.

On Mon, Apr 30, 2018 at 11:22 AM, Alexander Kolbasov <ak...@cloudera.com>
wrote:

> +1
>
> > On Apr 30, 2018, at 08:25, Sergio Pena <se...@cloudera.com> wrote:
> >
> > Hey All,
> >
> > I just want to share with the community about some helpful tips when
> > submitting patches for review that are useful for reviewers:
> >
> >   - Add a link to the review board on the JIRA related to the patch
> you're
> >   working on.
> >   - Add a link to the JIRA on the review board related to the patch
> you're
> >   working on (Add the JIRA in the Bugs field).
> >
> > These extra steps you do when submitting a patch save reviewers time when
> > looking for references on the JIRA or the Review Board. For instance:
> >
> >   - I miss the RB link to the patch. If I go to the JIRA, then I can find
> >   it and click on the link to take me to the patch (1 click) instead of
> >   searching the patch on the RB (takes time).
> >   - I want to go to the JIRA that is referenced in the RB patch. If I go
> >   to the Bugs field, then I can click on the link to take me to the JIRA
> (1
> >   click) instead of opening another window, go to JIRA, edit the JIRA
> number
> >   and press enter.
> >
> > I encourage to use that on current and future patches to also have a
> > reference to the review and who review the patch.
> >
> > - Sergio
>

Re: Quick tips for code reviews

[Alexander Kolbasov <ak...@cloudera.com>]

+1

> On Apr 30, 2018, at 08:25, Sergio Pena <se...@cloudera.com> wrote:
> 
> Hey All,
> 
> I just want to share with the community about some helpful tips when
> submitting patches for review that are useful for reviewers:
> 
>   - Add a link to the review board on the JIRA related to the patch you're
>   working on.
>   - Add a link to the JIRA on the review board related to the patch you're
>   working on (Add the JIRA in the Bugs field).
> 
> These extra steps you do when submitting a patch save reviewers time when
> looking for references on the JIRA or the Review Board. For instance:
> 
>   - I miss the RB link to the patch. If I go to the JIRA, then I can find
>   it and click on the link to take me to the patch (1 click) instead of
>   searching the patch on the RB (takes time).
>   - I want to go to the JIRA that is referenced in the RB patch. If I go
>   to the Bugs field, then I can click on the link to take me to the JIRA (1
>   click) instead of opening another window, go to JIRA, edit the JIRA number
>   and press enter.
> 
> I encourage to use that on current and future patches to also have a
> reference to the review and who review the patch.
> 
> - Sergio