Skip to content

Commit

Permalink
adding note about mentioning mob/pair programming
Browse files Browse the repository at this point in the history
  • Loading branch information
GordonBeeming committed Oct 28, 2023
1 parent b5d2a3e commit 388324f
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 7 deletions.
7 changes: 7 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@

{{ SUMMARY OF CHANGES }}

## Did you do pair or mob programming?

Worked with @{{ NAME }}, @{{ NAME }} and @{{ NAME }}

<!--
Have you seen our Rules to Better Pull Requests?
https://www.ssw.com.au/rules/rules-to-better-pull-requests/
Expand All @@ -19,4 +23,7 @@ See https://www.ssw.com.au/rules/write-a-good-pull-request/ for further guidance
Did you do an over the shoulder review?
https://www.ssw.com.au/rules/over-the-shoulder-prs
Did you do pair or mob programming?
https://www.ssw.com.au/rules/do-you-use-co-creation-patterns/
-->
25 changes: 18 additions & 7 deletions rules/write-a-good-pull-request/rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,10 @@ The key to writing a concise Pull Request is to base the PR itself on a PBI / is

Good titles cover:

a. What the Pull Request will do \
b. How the Pull Request achieved it \
a. What the Pull Request will do

b. How the Pull Request achieved it

c. Use emojis! - follow the [GitMoji.dev](https://gitmoji.dev) standard

Examples:
Expand Down Expand Up @@ -77,12 +79,20 @@ Good descriptions cover:
a. Give context
- an issue url (or tag the ID, e.g. #123)
- email subject, like the rule [Warn then call](https://www.ssw.com.au/rules/warn-then-call/)
- conversation, using the key phrase "[as per our conversation](https://www.ssw.com.au/rules/as-per-our-conversation-emails/)" \
- conversation, using the key phrase "[as per our conversation](https://www.ssw.com.au/rules/as-per-our-conversation-emails/)"

b. Did you do pair or mob programming?
- [Do you use Co-Creation Patterns?](https://www.ssw.com.au/rules/do-you-use-co-creation-patterns/)
- Example: Worked with @bob, @mary and @jane

c. What the PR is about and why did you raise it

d. How the PR will achieve the feature / fix the bug / other goals

e. Include a screenshot if it will help the reviewer to understand the changes (e.g. styling changes)

f. Tell he reviewers if there is an area you are uncertain about, e.g.: I'm looking for feedback on this code

b. What the PR is about and why did you raise it \
c. How the PR will achieve the feature / fix the bug / other goals \
d. Include a screenshot if it will help the reviewer to understand the changes (e.g. styling changes) \
e. Tell he reviewers if there is an area you are uncertain about, e.g.: I'm looking for feedback on this code

::: greybox
**PR title:** Update Rule “meaningful-pbi-titles/rule”
Expand Down Expand Up @@ -169,3 +179,4 @@ Linking a PBI/Issue to a PR can serve as documentation on which development work
::: good
![Figure: Good example - The PR is now associated with the related issue.](better-pr-link-issues-linked.png)
:::

0 comments on commit 388324f

Please sign in to comment.