Skip to content

Style guide fixes #17428

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

Merged
merged 9 commits into from
May 12, 2022
Merged

Style guide fixes #17428

merged 9 commits into from
May 12, 2022

Conversation

Rick-Anderson
Copy link
Contributor

@Rick-Anderson Rick-Anderson commented Apr 27, 2022

Why:

Style guide fixes. Shorter sentences are easier for native speakers and are far better for MT (Machine Translation).

What's being changed:

Check off the following:

  • I have reviewed my changes in staging (look for "Automatically generated comment" and click Modified to view your latest changes).
  • For content changes, I have completed the self-review checklist.

Writer impact (This section is for GitHub staff members only):

  • This pull request impacts the contribution experience
    • I have added the 'writer impact' label
    • I have added a description and/or a video demo of the changes below (e.g. a "before and after video")

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

github-actions bot commented Apr 27, 2022

Automatically generated comment ℹ️

This comment is automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.


Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source Preview Production What Changed
issues/tracking-your-work-with-issues/about-issues.md fpt
ghec
ghes@ 3.5 3.4 3.3 3.2 3.1
ghae
fpt
ghec
ghes@ 3.5 3.4 3.3 3.2 3.1
ghae

@ramyaparimi
Copy link
Contributor

@Rick-Anderson
Thanks so much for opening a PR! I'll get this triaged for review ⚡

@github-actions
Copy link
Contributor

github-actions bot commented May 5, 2022

A stale label has been added to this pull request because it has been open 7 days with no activity. To keep this PR open, add a comment or push a commit within 3 days.

@github-actions github-actions bot added the stale There is no recent activity on this issue or pull request label May 5, 2022
@ramyaparimi ramyaparimi added content This issue or pull request belongs to the Docs Content team 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 stale There is no recent activity on this issue or pull request labels May 6, 2022
@myarb myarb removed the waiting for review Issue/PR is waiting for a writer's review label May 10, 2022
@ramyaparimi
Copy link
Contributor

@Rick-Anderson We won’t be accepting this change, as our style guide indicates we start with the initiating action before the result 💛 .

Thanks so much for your time in contributing to the GitHub docs 💖 .

@Rick-Anderson
Copy link
Contributor Author

@ramyaparimi but the content is incorrect. Mentioning is not enough to close the issue. That's why I added a link.

@ramyaparimi
Copy link
Contributor

@Rick-Anderson Thanks so much for reaching out. I will triage this for the team to take a closer look at the changes. Thank you for your patience and passion in contributing to the GitHub docs 💖 .

@ramyaparimi ramyaparimi reopened this May 11, 2022
@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label May 11, 2022
@ramyaparimi ramyaparimi 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 May 11, 2022
myarb
myarb previously approved these changes May 12, 2022
Copy link
Contributor

@myarb myarb left a comment

Choose a reason for hiding this comment

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

Thank you for your contribution to the GitHub Docs! We'll merge the addition of a link to the article on keywords shortly.

@myarb myarb added ready to merge This pull request is ready to merge and removed waiting for review Issue/PR is waiting for a writer's review labels May 12, 2022
@ramyaparimi ramyaparimi enabled auto-merge May 12, 2022 16:30
@ramyaparimi ramyaparimi merged commit 5921456 into github:main May 12, 2022
@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. If you're looking for your next contribution, check out our help wanted issues

@Rick-Anderson Rick-Anderson deleted the patch-3 branch May 12, 2022 17:59
@Rick-Anderson
Copy link
Contributor Author

Rick-Anderson commented May 12, 2022

Thanks for accepting my PR. I get too many PR's such with various adjectives
Helps #1234
Contributes to #1234

That don't automatically close, so I'm trying to educate new folks by pointing to a GitHub doc like this. But with this accepted PR, it sounds like just linking the PR automatically closes it, which is not true

When the pull request merges, the linked issue automatically closes.

So it's not a one stop article.

Copy link

@sandrosov7153 sandrosov7153 left a comment

Choose a reason for hiding this comment

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

Привет давай знакомиться я я Серёга

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 ready to merge This pull request is ready to merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants