forked from github/docs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix: Update commit trailer Tip (github#2003)
* Update commit trailer Tip Previously stated "Co-authored-by:" when it should say "on-behalf-of". Found https://docs.github.com/en/free-pro-team@latest/github/committing-changes-to-your-project/creating-a-commit-on-behalf-of-an-organization * refactor: remove dependency of reusable file, by hard-copy * refactor: remove reusable file Co-authored-by: hubwriter <[email protected]>
- Loading branch information
1 parent
1aebff4
commit 9669f20
Showing
3 changed files
with
22 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -26,7 +26,17 @@ Organization's can use the `[email protected]` email as a public point of co | |
|
||
### Creating commits with an `on-behalf-of` badge on the command line | ||
|
||
{% data reusables.pull_requests.commit-message-with-trailer-beginning %} | ||
1. Type your commit message and a short, meaningful description of your changes. After your commit description, instead of a closing quotation, add two empty lines. | ||
```shell | ||
$ git commit -m "Refactor usability tests. | ||
> | ||
> | ||
``` | ||
{% tip %} | ||
**Tip:** If you're using a text editor on the command line to type your commit message, ensure there are two newlines between the end of your commit description and the `on-behalf-of:` commit trailer. | ||
{% endtip %} | ||
2. On the next line of the commit message, type `on-behalf-of: @org <[email protected]>`, then a closing quotation mark. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -39,7 +39,17 @@ You can use {% data variables.product.prodname_desktop %} to create a commit wit | |
|
||
{% data reusables.pull_requests.collect-co-author-commit-git-config-info %} | ||
|
||
{% data reusables.pull_requests.commit-message-with-trailer-beginning %} | ||
1. Type your commit message and a short, meaningful description of your changes. After your commit description, instead of a closing quotation, add two empty lines. | ||
```shell | ||
$ git commit -m "Refactor usability tests. | ||
> | ||
> | ||
``` | ||
{% tip %} | ||
**Tip:** If you're using a text editor on the command line to type your commit message, ensure there are two newlines between the end of your commit description and the `Co-authored-by:` commit trailer. | ||
{% endtip %} | ||
3. On the next line of the commit message, type `Co-authored-by: name <[email protected]>` with specific information for each co-author. After the co-author information, add a closing quotation mark. | ||
|
11 changes: 0 additions & 11 deletions
11
data/reusables/pull_requests/commit-message-with-trailer-beginning.md
This file was deleted.
Oops, something went wrong.