Skip to content

Commit 9669f20

Browse files
fix: Update commit trailer Tip (#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 <hubwriter@github.com>
1 parent 1aebff4 commit 9669f20

3 files changed

Lines changed: 22 additions & 13 deletions

File tree

content/github/committing-changes-to-your-project/creating-a-commit-on-behalf-of-an-organization.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,17 @@ Organization's can use the `name@organization.com` email as a public point of co
2626

2727
### Creating commits with an `on-behalf-of` badge on the command line
2828

29-
{% data reusables.pull_requests.commit-message-with-trailer-beginning %}
29+
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.
30+
```shell
31+
$ git commit -m "Refactor usability tests.
32+
>
33+
>
34+
```
35+
{% tip %}
36+
37+
**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.
38+
39+
{% endtip %}
3040
3141
2. On the next line of the commit message, type `on-behalf-of: @org <name@organization.com>`, then a closing quotation mark.
3242

content/github/committing-changes-to-your-project/creating-a-commit-with-multiple-authors.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,17 @@ You can use {% data variables.product.prodname_desktop %} to create a commit wit
3939

4040
{% data reusables.pull_requests.collect-co-author-commit-git-config-info %}
4141

42-
{% data reusables.pull_requests.commit-message-with-trailer-beginning %}
42+
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.
43+
```shell
44+
$ git commit -m "Refactor usability tests.
45+
>
46+
>
47+
```
48+
{% tip %}
49+
50+
**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.
51+
52+
{% endtip %}
4353
4454
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.
4555

data/reusables/pull_requests/commit-message-with-trailer-beginning.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

0 commit comments

Comments
 (0)