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

XS✔ ◾ Updating communicating expectations PR rule #7198

Merged
merged 5 commits into from
Nov 7, 2023
Merged

XS✔ ◾ Updating communicating expectations PR rule #7198

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f3c07a8
Adding related rule to communicate expectations
GordonBeeming Nov 7, 2023
c1dc3ca
Add reference to the SSWConsulting/SSW.GitHub.Template
GordonBeeming Nov 7, 2023
bf728f8
Updating the good example to have our latest template
GordonBeeming Nov 7, 2023
661a699
Updating good example figure
GordonBeeming Nov 7, 2023
40b15e6
Adding an ok example for the comments only approach to PR templates
GordonBeeming Nov 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added ...equest-templates-to-communicate-expectations/pr-template-asking-for-context.jpg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 7 additions & 2 deletions rules/use-pull-request-templates-to-communicate-expectations/rule.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,14 @@ When creating a PR template, think of how you can help developers create great P
![Figure: Bad example - There is no information to guide developers](no-pr-template.jpg)
:::

::: ok
![Figure: OK example - The PR template contains handy links to guidance for creating great PRs ⭐](pr-template-with-comments-to-guidance.jpg)
:::

::: good
![Figure: Good example - The PR template contains handy links to guidance for creating great PRs ⭐](pr-template-with-comments-to-guidance.jpg)
![Figure: Good example - This PR template asks for **context needed to review**, along with links to guidance for creating great PRs ⭐](pr-template-asking-for-context.jpg)
:::

**Tip:** You can use comments in the markdown as above. These comments will not show when the PR is created, and is only visible when editing the description.


For a great Pull Request template, take a look at [@SSWConsulting/SSW.GitHub.Template](https://github.com/SSWConsulting/SSW.GitHub.Template/blob/main/.github/pull_request_template.md)
2 changes: 1 addition & 1 deletion rules/write-a-good-pull-request/rule.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ related:
- use-emojis-in-your-commits
- which-emojis-to-use-in-scrum
- use-emojis
- use-pull-request-templates-to-communicate-expectations
redirects:
- do-you-know-how-to-write-a-good-pull-request
created: 2020-07-17T01:21:08.000Z
Expand Down Expand Up @@ -176,7 +177,6 @@ A: If you're using a GUI editor for your PRs, you may need to go to the PR after
![Figure: Good example - Updating the PR description to follow the repository standard helps you provide context to reviewers](cms-good-example.png)
:::


### 3. Link the Pull Request to the associated issues / PBIs

::: info
Expand Down
Loading