Skip to content

Commit

Permalink
fix: Update commit trailer Tip (#2003)
Browse files Browse the repository at this point in the history
* 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 <hubwriter@github.com>
  • Loading branch information
DanielTamkin and hubwriter authored Jan 14, 2021
1 parent 1aebff4 commit 9669f20
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 13 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,17 @@ Organization's can use the `name@organization.com` 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 <name@organization.com>`, then a closing quotation mark.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 <name@example.com>` with specific information for each co-author. After the co-author information, add a closing quotation mark.
Expand Down

This file was deleted.

0 comments on commit 9669f20

Please sign in to comment.