Skip to content

Clarify language on pull request review#522

Merged
aduth merged 3 commits intomainfrom
aduth-pr-review-clarity
Mar 7, 2024
Merged

Clarify language on pull request review#522
aduth merged 3 commits intomainfrom
aduth-pr-review-clarity

Conversation

@aduth
Copy link
Contributor

@aduth aduth commented Mar 7, 2024

This makes a few revisions to the Pull Request Process article to improve the clarity of the language:

  • Be very clear about "one approving review" (vs. ambiguous "approval")
  • Add note about potential exceptions for others merging a pull request (see recent example)
  • Use full names instead of acronyms ("pull request" instead of "PR", "continuous integration" instead of "CI")
  • Capitalize GitHub consistently

This was motivated partly by a recent discussion about our peer review procedure, and whether we have documented expectations around how approval works.

Live preview: https://federalist-7d0b2b76-42fc-4df1-9825-8c3cd77e0a15.sites.pages.cloud.gov/preview/gsa-tts/identity-handbook/aduth-pr-review-clarity/articles/pull-request-review.html

@aduth aduth force-pushed the aduth-pr-review-clarity branch from 308bc0d to 16ca44f Compare March 7, 2024 19:12
@aduth aduth merged commit 3f16eeb into main Mar 7, 2024
@aduth aduth deleted the aduth-pr-review-clarity branch March 7, 2024 19:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants