Skip to content

Commit 806efa7

Browse files
author
Randy Pagels
committed
Clarify guidance on using emojis and @mentions in commit messages; add tip for following CONTRIBUTING.md or PR template.
1 parent 2495333 commit 806efa7

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

learn-pr/github/contribute-open-source/includes/4-exercise-create-pr.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ To write a good commit message, and subsequently your pull request, follow these
99
- Include a succinct description of the change by using the imperative, present tense. For example, use *add* not *added* or *adds*.
1010
- Limit your subject line to 50 characters.
1111
- Start with a capital letter, and don't end with a period (.).
12-
- You can use emojis in your subject line and `@mention` other GitHub users, but not everyone is a fan of such frivolity.
12+
- You can use emojis or `@mention` other GitHub users in your subject line, but be mindful that not all projects encourage this.
1313

1414
For the body of your message and pull request, continue to use present tense. Make sure to include the motivation for the change. Contrast your change with the previous behavior. Use the space at your disposal to explain the *what* and *why* versus the *how*.
1515

@@ -19,6 +19,8 @@ Your commit message is only as much to the point as the content that you're abou
1919

2020
Before you submit your pull request, check the sidebar for ways to complete your PR. Select **Reviewers** or **Assignees** if you're familiar with the project's team structure. Add *labels* when there's guidance on using labels in, for instance, the CONTRIBUTING.md file. You can use labels as a visual clue for what you're trying to accomplish. A maintainer might also add a label or multiple labels.
2121

22+
**Tip:** *If the repository has a CONTRIBUTING.md file or a PR template, be sure to follow its guidance when filling in your pull request.*
23+
2224
Some of the labels we use in the repository for this Learn module are:
2325

2426
- **Bug** (red): Something isn't working

0 commit comments

Comments
 (0)