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.

Sign up for GitHub

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

Jump to bottom

Reorganise code reviews section #680

Open
wants to merge 11 commits into
base: main
Choose a base branch
from
Open

Reorganise code reviews section #680

wants to merge 11 commits into from

Commits on Apr 6, 2022

  1. Split code review content 

    This is using the Diátaxis approaches of:

* picking some documentation arbitrarily and trying to make small
  improvements
* keeping different categories of documentation separate

As written, this felt like a mixture of explanation and how-to guide, so
split these out into two different pages.
    @StevenMaude
    StevenMaude committed Apr 6, 2022
    Configuration menu
    Copy the full SHA
    b63ab68 View commit details
    Browse the repository at this point in the history

  2. Rewrite introduction to code reviews slightly 

    * Simplify some of the text.
* Explicitly explain what authors and reviewers can gain from code
  reviews.
* Use semantic line breaks.
    @StevenMaude
    StevenMaude committed Apr 6, 2022
    Configuration menu
    Copy the full SHA
    f2a5550 View commit details
    Browse the repository at this point in the history

  3. Fix some whitespace issues

    @StevenMaude
    StevenMaude committed Apr 6, 2022
    Configuration menu
    Copy the full SHA
    481bbd6 View commit details
    Browse the repository at this point in the history

  4. Separate and expand "how to perform a code review"

    @StevenMaude
    StevenMaude committed Apr 6, 2022
    Configuration menu
    Copy the full SHA
    bc7b082 View commit details
    Browse the repository at this point in the history

  5. Fix item list formatting in code reviews page

    @StevenMaude
    StevenMaude committed Apr 6, 2022
    Configuration menu
    Copy the full SHA
    f9989a7 View commit details
    Browse the repository at this point in the history

  6. Develop the pull request content more 

    * Complete some incomplete thoughts.
* Reword a few sentences.
* Use more semantic line breaks in edited content.
    @StevenMaude
    StevenMaude committed Apr 6, 2022
    Configuration menu
    Copy the full SHA
    27365d0 View commit details
    Browse the repository at this point in the history

  7. Fix list formatting

    @StevenMaude
    StevenMaude committed Apr 6, 2022
    Configuration menu
    Copy the full SHA
    028c672 View commit details
    Browse the repository at this point in the history

  8. Move small section on encouraging code reviews 

    As it seemed more "about code review" than "how to do a code review".
    @StevenMaude
    StevenMaude committed Apr 6, 2022
    Configuration menu
    Copy the full SHA
    dfecc3b View commit details
    Browse the repository at this point in the history

  9. Split author and reviewer code review sections

    @StevenMaude
    StevenMaude committed Apr 6, 2022
    Configuration menu
    Copy the full SHA
    a7edfe1 View commit details
    Browse the repository at this point in the history

  10. Change page title 

    The page no longer really discusses using code reviews, but solely what
they are.
    @StevenMaude
    StevenMaude committed Apr 6, 2022
    Configuration menu
    Copy the full SHA
    0ae9452 View commit details
    Browse the repository at this point in the history

  11. Reorder sections 

    The "when to ask for code review?" logically should be ahead of the
"how?".
    @StevenMaude
    StevenMaude committed Apr 6, 2022
    Configuration menu
    Copy the full SHA
    3039c69 View commit details
    Browse the repository at this point in the history