doc: add docs for dealing with special characters in ref names#9577
doc: add docs for dealing with special characters in ref names#9577lucascosti merged 11 commits intomainfrom
Conversation
|
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. |
0d4dfed to
e3d08aa
Compare
georgebrock
left a comment
There was a problem hiding this comment.
These are great docs! I made a couple of very small suggestions, but this is already very thorough and helpful as-is ✨
content/get-started/using-git/dealing-with-special-characters-in-branch-and-tag-names.md
Outdated
Show resolved
Hide resolved
content/get-started/using-git/dealing-with-special-characters-in-branch-and-tag-names.md
Outdated
Show resolved
Hide resolved
There are a few places in the UI where we provide instructions for how to do things on the command-line. We can provide shell-friendly escaped versions of _most_ branch names, but there will always be some edge-casey ones (eg. names containing single quotes) for which the escaping rules vary subtly by shell. Rather than try to cram a dozen variants of the commands into the UI, we want to direct people to the docs for such problematic names. The intent here is not to document every shell's rules (doomed to be incomplete and become stale over time), but rather provide a flavour of what users should be aware of, and some helpful links to jumping off to official upstream docs for commonly-used shells. Closes: https://github.com/github/coding/issues/2388
Because it was failing this test:
● pages module › loadPages › every English page has a filename that matches its slugified title
as seen here:
https://github.com/github/docs/pull/9577/checks?check_run_id=3524790084
As per style guide:
https://github.com/github/docs/blob/main/contributing/content-style-guide.md
and self-review checklist:
https://github.com/github/docs/blob/main/CONTRIBUTING.md#self-review
- Avoided nominalization in one place (eg. "for structure" instead of
"to provide organization", which might have been confused with a
_GitHub_ organization).
- Change passive to active voice in one place (eg. "most shells would
interpret" instead of "would be interpreted by most shells").
e3d08aa to
d1d177c
Compare
|
@wincent |
|
@ramyaparimi any thoughts on when this PR will be reviewed? |
|
@codeminator Thanks for reaching out. We have a limited set of resources to pull from in order to get work done in the open source repository. We do our best to get things addressed as quickly as possible. Unfortunately, we can’t promise exactly when this will be handled, but rest assured that it is in the hands of the proper team and we’ll get to it as rapidly as we can with resources and other priorities in mind. Thanks for your patience and your contributions to the GitHub docs. |
|
👋 Thanks a lot for providing the content for this article, @wincent! 🙇♂️ I'm sorry that it's taken us a while to get to reviewing this. I've push up an edit in 1b903fc, which breaks the content up into digestible sections, and also made some wording/formatting edits for it to align with our style guides and language recommendations. Please let me know if I've unintentionally changed the meaning of anything that makes it incorrect. Because I've made significant changes, I'll get someone else on the team to give it a quick review of my changes. |
martin389
left a comment
There was a problem hiding this comment.
Thanks for this PR! I've added some small suggestions 👍
content/get-started/using-git/dealing-with-special-characters-in-branch-and-tag-names.md
Outdated
Show resolved
Hide resolved
content/get-started/using-git/dealing-with-special-characters-in-branch-and-tag-names.md
Outdated
Show resolved
Hide resolved
content/get-started/using-git/dealing-with-special-characters-in-branch-and-tag-names.md
Outdated
Show resolved
Hide resolved
content/get-started/using-git/dealing-with-special-characters-in-branch-and-tag-names.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Martin Lopes <martin389@github.com>
|
Thanks, @martin389! 🙇♂️ @wincent Let me know if you're happy to get this merged in 🙂 |
@lucascosti, thanks for the edits and @martin389, thanks for the review! This looks great to me. |
|
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 ⚡ |
Why:
There are a few places in the UI where we provide instructions for how to do things on the command-line. We can provide shell-friendly escaped versions of most branch names, but there will always be some edge-casey ones (eg. names containing single quotes) for which the escaping rules vary subtly by shell. Rather than try to cram a dozen variants of the commands into the UI, we want to direct people to the docs for such problematic names.
What's being changed:
The intent here is not to document every shell's rules (doomed to be incomplete and become stale over time), but rather provide a flavour of what users should be aware of, and some helpful links to jumping off to official upstream docs for commonly-used shells.
Closes: https://github.com/github/coding/issues/2388
Check off the following:
Writer impact (This section is for GitHub staff members only):
cc @codeminator and @georgebrock