From c3d5690207dc667855f56fb6e164612bb1cb0df9 Mon Sep 17 00:00:00 2001 From: Daniel Tamkin <9532762+DanielTamkin@users.noreply.github.com> Date: Fri, 11 Dec 2020 10:46:42 -0600 Subject: [PATCH 1/3] 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 --- .../pull_requests/commit-message-with-trailer-beginning.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/reusables/pull_requests/commit-message-with-trailer-beginning.md b/data/reusables/pull_requests/commit-message-with-trailer-beginning.md index 08c05d621e1c..76562f03bb5f 100644 --- a/data/reusables/pull_requests/commit-message-with-trailer-beginning.md +++ b/data/reusables/pull_requests/commit-message-with-trailer-beginning.md @@ -6,6 +6,6 @@ ``` {% 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. + **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 %} From 53829a27f38177078b5b3ee6f039f31a2bea3c77 Mon Sep 17 00:00:00 2001 From: DanielTamkin <9532762+DanielTamkin@users.noreply.github.com> Date: Wed, 13 Jan 2021 21:29:22 -0600 Subject: [PATCH 2/3] refactor: remove dependency of reusable file, by hard-copy --- ...creating-a-commit-on-behalf-of-an-organization.md | 12 +++++++++++- .../creating-a-commit-with-multiple-authors.md | 12 +++++++++++- 2 files changed, 22 insertions(+), 2 deletions(-) diff --git a/content/github/committing-changes-to-your-project/creating-a-commit-on-behalf-of-an-organization.md b/content/github/committing-changes-to-your-project/creating-a-commit-on-behalf-of-an-organization.md index a84bef98b1c3..6d49572ebd85 100644 --- a/content/github/committing-changes-to-your-project/creating-a-commit-on-behalf-of-an-organization.md +++ b/content/github/committing-changes-to-your-project/creating-a-commit-on-behalf-of-an-organization.md @@ -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 `, then a closing quotation mark. diff --git a/content/github/committing-changes-to-your-project/creating-a-commit-with-multiple-authors.md b/content/github/committing-changes-to-your-project/creating-a-commit-with-multiple-authors.md index 0f1e8124bdd0..475a356cd986 100644 --- a/content/github/committing-changes-to-your-project/creating-a-commit-with-multiple-authors.md +++ b/content/github/committing-changes-to-your-project/creating-a-commit-with-multiple-authors.md @@ -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 ` with specific information for each co-author. After the co-author information, add a closing quotation mark. From 2b62b5966a31ccdf01b64d247a4459ca527da523 Mon Sep 17 00:00:00 2001 From: DanielTamkin <9532762+DanielTamkin@users.noreply.github.com> Date: Wed, 13 Jan 2021 21:38:53 -0600 Subject: [PATCH 3/3] refactor: remove reusable file --- .../commit-message-with-trailer-beginning.md | 11 ----------- 1 file changed, 11 deletions(-) delete mode 100644 data/reusables/pull_requests/commit-message-with-trailer-beginning.md diff --git a/data/reusables/pull_requests/commit-message-with-trailer-beginning.md b/data/reusables/pull_requests/commit-message-with-trailer-beginning.md deleted file mode 100644 index 76562f03bb5f..000000000000 --- a/data/reusables/pull_requests/commit-message-with-trailer-beginning.md +++ /dev/null @@ -1,11 +0,0 @@ -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 %}