Skip to content
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

Merged
merged 6 commits into from
Jan 14, 2021
Merged

fix: Update commit trailer Tip #2003

merged 6 commits into from
Jan 14, 2021

Conversation

DanielTamkin
Copy link
Contributor

@DanielTamkin DanielTamkin commented Dec 11, 2020

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 of Co-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:

  • All of the tests are passing.
  • I have reviewed my changes in staging. (look for the deploy-to-heroku link in your pull request, then click View deployment)
  • For content changes, I have reviewed the localization checklist
  • For content changes, I have reviewed the Content style guide for GitHub Docs.

@welcome
Copy link

welcome bot commented Dec 11, 2020

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
Copy link
Contributor Author

DanielTamkin commented Dec 11, 2020

* [ ]  I have reviewed my changes in staging. (look for the **deploy-to-heroku** link in your pull request, then click **View deployment**)

image

Seems the Heroku instance is throwing an error, enable to checkoff this tag until that is fixed... have verified on local though.

@DanielTamkin DanielTamkin marked this pull request as ready for review December 11, 2020 17:00
@janiceilene
Copy link
Contributor

janiceilene commented Dec 11, 2020

@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

@janiceilene janiceilene added content This issue or pull request belongs to the Docs Content team core labels Dec 11, 2020
@DanielTamkin
Copy link
Contributor Author

DanielTamkin commented Dec 12, 2020

Thanks @janiceilene! (That response time was crazy fast)

Looking forward to the review 😊

pablo452 referenced this pull request Dec 12, 2020
* 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>
@github-actions
Copy link
Contributor

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.

@github-actions github-actions bot added the stale There is no recent activity on this issue or pull request label Dec 22, 2020
@janiceilene janiceilene removed the stale There is no recent activity on this issue or pull request label Dec 22, 2020
@janiceilene
Copy link
Contributor

Thanks for your patience! Our small team is working our way through reviewing all of the amazing contributions ✨

@github-actions
Copy link
Contributor

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.

@github-actions github-actions bot added the stale There is no recent activity on this issue or pull request label Dec 30, 2020
@janiceilene janiceilene removed the stale There is no recent activity on this issue or pull request label Jan 4, 2021
@DanielTamkin
Copy link
Contributor Author

No worries on the wait @janiceilene! It's the holidays after all 😊

Copy link
Contributor

@hubwriter hubwriter left a 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:

  1. 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.
  2. 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").
  3. 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.

@hubwriter hubwriter self-assigned this Jan 7, 2021
@DanielTamkin
Copy link
Contributor Author

Thanks for the review @hubwriter! I'll add these suggested changes as soon as I can.

@DanielTamkin
Copy link
Contributor Author

Hope these changes address your review @hubwriter!

Copy link
Contributor

@hubwriter hubwriter left a 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. 👍

@hubwriter hubwriter merged commit 9669f20 into github:main Jan 14, 2021
@github-actions
Copy link
Contributor

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants