-
Notifications
You must be signed in to change notification settings - Fork 60.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix: Update commit trailer Tip #2003
Conversation
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
Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines. |
@DanielTamkin Thanks so much for opening a PR! I'll get this triaged for review ⚡ It looks like the staging server was taking a long time for some reason, but your changes are visible now! https://docs-2003--patch-1.herokuapp.com/en/free-pro-team@latest/github/committing-changes-to-your-project/creating-a-commit-on-behalf-of-an-organization |
Thanks @janiceilene! (That response time was crazy fast) Looking forward to the review 😊 |
* Add author key to package.json * Remove version key * Change name to `docs.github.com` * Update package-lock Co-authored-by: Zeke Sikelianos <zeke@sikelianos.com>
This PR is stale because it has been open 7 days with no activity and will be automatically closed in 3 days. To keep this PR open, update the PR by adding a comment or pushing a commit. |
Thanks for your patience! Our small team is working our way through reviewing all of the amazing contributions ✨ |
This PR is stale because it has been open 7 days with no activity and will be automatically closed in 3 days. To keep this PR open, update the PR by adding a comment or pushing a commit. |
No worries on the wait @janiceilene! It's the holidays after all 😊 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@DanielTamkin - Apologies for the delay reviewing this over the holiday period. This is a great catch. Many thanks for contributing! 👍
Your suggested change needs a couple of changes however. You've updated the text in a "reusable" file, the text of which is currently used in 2 topics: "Creating a commit on behalf of an organization" and "Creating a commit with multiple authors" - the original text is correct for the latter, so it needs to stay unchanged in that topic.
As a result we need to:
- Update
docs-internal/content/github/committing-changes-to-your-project/creating-a-commit-on-behalf-of-an-organization.md
to use the text you suggest (with "on-behalf-of") - directly in that file, rather than in the reusable file. - Update
github/committing-changes-to-your-project/creating-a-commit-with-multiple-authors.md
to use the text currently imported from the reusable file (with "Co-authored-by"). - Delete the reusable file (data/reusables/pull_requests/commit-message-with-trailer-beginning.md) as it's not needed any more after changes 1 and 2.
Thanks for the review @hubwriter! I'll add these suggested changes as soon as I can. |
Hope these changes address your review @hubwriter! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@DanielTamkin - Many thanks. These changes are perfect!
Thanks again for contributing. 👍
Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. |
Found when learning how to create a commit on behalf of an organization.
Why:
While learning about
on-behalf-of
, was confused to the mention ofCo-authored-by:
. Only mention in this page with no correlation to the later trailer. May have been a miss when updating docs?What's being changed:
Previously stated "Co-authored-by:" when it should say "on-behalf-of". In tooltip.
Check off the following: