Skip to content

Commit

Permalink
Merge pull request #942 from alphagov/pull-request-chores
Browse files Browse the repository at this point in the history
Chore: Tidy up some formatting on the pull request pages
  • Loading branch information
huwd authored Nov 5, 2024
2 parents abf7917 + 772f4d6 commit 99686e7
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions source/standards/pull-requests.html.md.erb
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: Pull requests
last_reviewed_on: 2023-07-21
last_reviewed_on: 2024-11-05
review_in: 12 months
---
# <%= current_page.data.title %>

Pull requests (PRs) let you tell others about changes you've pushed to a branch in a repository on GitHub.
Pull requests (PRs) let you tell others about changes youve pushed to a branch in a repository on GitHub.

## Why should you use pull requests?

Expand Down Expand Up @@ -35,7 +35,7 @@ You should make sure that:

- your local repository has the most recent changes on the target branch
- the title and description of the PR are clear and accurately represent your changes
- the title and description reference the source of the change, which could be a Zendesk ticket or a Jira card
- the title and description reference the source of the change, which could be a support ticket (Zendesk, or Service Now) or a Jira card
- the description contains links to any related PRs
- any screenshots have text descriptions for accessibility
- any contentious changes or side effects have clear descriptions of the pros and cons
Expand All @@ -46,11 +46,11 @@ As such, the canonical description of changes should be in the commit messages.

### Reviewing a request

Taking time to properly review a PR is as important as making the change itself, and it is crucial that we show compassion when critiquing someone else's work.
Taking time to properly review a PR is as important as making the change itself, and it is crucial that we show compassion when critiquing someone elses work.

April Wensel has a talk about [Compassionate-Yet-Candid Code Reviews](https://www.slideshare.net/AprilWensel/compassionate-yet-candid-code-reviews).

It suggests 3 key questions to ask ourselves when reviewing or commenting on someone else's work:
It suggests 3 key questions to ask ourselves when reviewing or commenting on someone elses work:

- Is it true?
- Is it necessary?
Expand Down Expand Up @@ -116,7 +116,7 @@ If we do not want to merge it because it does not fit with our plans, thank them

If it fits, but we cannot merge it due to quality or style issues, then tell them that we are able to merge the PR if they make some changes.

We can tell the requester what improvements we'd like to see, but we should not require the contributor to make them all. For example, we might add missing tests ourselves or collaborate with them to add tests.
We can tell the requester what improvements wed like to see, but we should not require the contributor to make them all. For example, we might add missing tests ourselves or collaborate with them to add tests.

We should close PRs due to lack of activity but invite people to reopen them if they pick things up again.

Expand Down

0 comments on commit 99686e7

Please sign in to comment.