Skip to content

Commit

Permalink
fix(git): resolve typos within the pull request documentation page
Browse files Browse the repository at this point in the history
'Title' was displayed correctly in subheader, but as 'Subject' in page content (as per GitHub documentation, this should indeed be 'Title'; ref: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request#:~:text=Type%20a-,title,-and%20description%20for)
  • Loading branch information
samharp committed Dec 15, 2023
1 parent 59e534d commit f852e34
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions git/pull-request-naming.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Consists of two parts:
- Title: Short informative summary of the pull request
- Description: More detailed explanatory text describing the PR for the reviewer

## Subject:
## Title:
- Short and descriptive summary
- Start with corresponding ticket/story id (e.g. from Jira, GitHub issue, etc.)
- Should be capitalized and written in imperative present tense
Expand Down Expand Up @@ -32,4 +32,4 @@ To achieve this, we needed to:
- Find the best Gitbook plugin which can do the work
- Integrate it in all the pages to redirect the user to the right page on GitHub for editing
- Make it visible on the page so users can notice it easily
```
```

0 comments on commit f852e34

Please sign in to comment.