Skip to content

Commit

Permalink
Added related + improved title + other small changes
Browse files Browse the repository at this point in the history
  • Loading branch information
tiagov8 authored Apr 11, 2024
1 parent 95c7e93 commit b455caf
Showing 1 changed file with 9 additions and 7 deletions.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
type: rule
title: Do you use Pull Request templates to communicate expectations?
title: Do you use Pull Request Templates to specify the expectations and requirements for each PR?
uri: use-pull-request-templates-to-communicate-expectations
authors:
- title: Gordon Beeming
Expand All @@ -13,18 +13,20 @@ authors:
url: https://ssw.com.au/people/adam-cogan
- title: Seth Daily
url: https://ssw.com.au/people/seth-daily
related:
- write-a-good-pull-request
created: 2023-09-06T16:24:00.000Z
guid: 8e378b56-3161-4433-81c0-40119075d137
archivedreason: null
---

Pull Request templates are a great way to communicate expectations to developers. You should create different PR templates for different types of PRs. For example, you can have a PR template for bug fixes, a PR template for new features, and a PR template for refactoring. You are also able to create specific PR templates for specific code paths.

You can read how to implement PR templates in the GitHub docs at [Creating a pull request template for your repository](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository)

<!--endintro-->

When creating a PR template, think of how you can help developers create great PRs
You can read how to implement PR templates in the [GitHub Docs - Creating a pull request template for your repository](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository).

When creating a PR template, think of how you can help developers create great PRs.

::: bad
![Figure: Bad example - There is no information to guide developers](no-pr-template.jpg)
Expand All @@ -35,9 +37,9 @@ When creating a PR template, think of how you can help developers create great P
:::

::: good
![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)
![Figure: Good example - This PR template asks for context (to help reviewers), along with guidance links 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.
**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)
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).

0 comments on commit b455caf

Please sign in to comment.