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

Style guide updates #36455

Merged
merged 2 commits into from
Feb 25, 2025
Merged

Style guide updates #36455

merged 2 commits into from
Feb 25, 2025

Conversation

hdub-tech
Copy link
Contributor

@hdub-tech hdub-tech commented Feb 24, 2025

Why:

Fixes: Small style issues discovered while reading the various Terms of Service

What's being changed (if available, include any code snippets, screenshots, or gifs):

Punctuation, formatting, and phrasing changes were made to match the Style guide (This is one of the only PRs I have ever opened where I feel like the Files Changed tab should be sufficient to demonstrate changes, without needing extra images, details or a separate issue).

Check off the following:

  • A subject matter expert (SME) has reviewed the technical accuracy of the content in this PR. In most cases, the author can be the SME. Open source contributions may require an SME review from GitHub staff.
  • The changes in this PR meet the docs fundamentals that are required for all content.
  • All CI checks are passing and the changes look good in the review environment.

@hdub-tech hdub-tech requested a review from a team as a code owner February 24, 2025 17:49
Copy link

welcome bot commented Feb 24, 2025

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.

Copy link
Contributor

github-actions bot commented Feb 24, 2025

How to review these changes 👓

Thank you for your contribution. To review these changes, choose one of the following options:

A Hubber will need to deploy your changes internally to review.

Table of review links

⚠️ Warning: Our review server is experiencing latency issues.

The table shows the files in the content directory that were changed in this pull request. This helps you review your changes on the review server. Changes to the data directory are not included in this table.

Source Review Production What Changed
support/learning-about-github-support/about-github-premium-support.md ghec
ghes@ 3.15 3.14 3.13 3.12
ghec
ghes@ 3.15 3.14 3.13 3.12
actions/monitoring-and-troubleshooting-workflows/troubleshooting-workflows/working-with-support-for-github-actions.md fpt
ghec
ghes@ 3.15 3.14 3.13 3.12
fpt
ghec
ghes@ 3.15 3.14 3.13 3.12
from reusable
support/learning-about-github-support/about-github-support.md fpt
ghec
ghes@ 3.15 3.14 3.13 3.12
fpt
ghec
ghes@ 3.15 3.14 3.13 3.12
from reusable

Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server

🤖 This comment is automatically generated.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Feb 24, 2025
Copy link
Contributor

@subatoi subatoi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @hdub-tech, thanks for raising this—I've just left a few small comments for you to address and then we should be good to merge this. Thanks for your interest in our docs and style guide!

@subatoi subatoi added waiting for review Issue/PR is waiting for a writer's review and removed triage Do not begin working on this issue until triaged by the team labels Feb 24, 2025
@@ -60,7 +60,7 @@ Personal Data is collected from you directly, automatically from your device, an
* Essential Cookies and Similar Tracking Technologies: We use cookies and similar technologies to provide essential functionality like storing settings and recognizing you while using our Services.
* Non-essential Cookies: Depending on your jurisdiction, we may use online analytics products that use cookies to help us analyze how de-identified users use our Services and to enhance your experience when you use the Services. We may also employ third-party Cookies to gather data for interest-based advertising. In some jurisdictions, we only use non-essential cookies after obtaining your consent. See [this](#what-are-your-cookie-choices-and-controls) section for more details and control options.
* Email Marketing Interactions: Our emails may have web beacons that offer information on your device type, email client, email reception, opens, and link clicks.
* Geolocation Information: Depending on the Service's functionality, we collect regional geolocation data
* Geolocation Information: Depending on the Service's functionality, we collect regional geolocation data.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know this is frustrating but let's leave this out of this PR: I'll raise it separately with our Site Policy team

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ha, understood. It was the one thing that jumped off the page to my eyes and was actually what led me to start the PR 😅 . I will revert this commit momentarily.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I should have asked @hdub-tech but if you'd prefer to raise it yourself, you can do so here https://github.com/github/site-policy/blob/main/CONTRIBUTING.md

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh is there not already an internal issue for it? Either way, I can open a public one for you if you did not already beat me to it.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I haven't opened one yet; I wanted to give you the option to open one publicly, so you'd get the full credit for it. Either way just let me know here 👍

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Apologies on the delay, I didn't receive a notification for your comment! Here is the issue: https://github.com/github/docs/issues/36556

Inconsistent capitalization and table formatting
- Remove inconsistent periods in list
- Remove "etc" per style guide
@hdub-tech
Copy link
Contributor Author

OK @subatoi - I think this addresses all your concerns. LMK if I missed anything.

Copy link
Contributor

@subatoi subatoi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks again, @hdub-tech! I'll get this merged for you now.

Thanks for your interest in our Docs!

@subatoi subatoi added this pull request to the merge queue Feb 25, 2025
Merged via the queue into github:main with commit a46948d Feb 25, 2025
45 checks passed
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. If you're looking for your next contribution, check out our help wanted issues

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
waiting for review Issue/PR is waiting for a writer's review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants