feat: Added Git cheatsheet #74
Conversation
|
I think this may be one for TheKnowledge repo as it is more tutorial/documentation based than high level practices. Personally I would scrap the meme, but I don't feel strongly one way or the other. |
There was a problem hiding this comment.
Sorry for the comment spam!
Most of my musings are about styling, which might seem trivial but we have a way of converting all of this lovely markdown to a static website (i.e. rendered HTML) and if there are bits that deviate, it could make things look odd, especially compared to other pages!
|
|
||
|  | ||
|
|
||
| ## **Welcome!** |
There was a problem hiding this comment.
Titles shouldn't need the additional bold-ificiation here i.e. drop the **'s, please :)
(surprised markdownlint didn't pick up on this, to be honest!
There are exceptions to this rule, but adding what is effectively a <b>bold</b> tag to all headings is unnecessary.
|
|
||
| ## **Welcome!** | ||
|
|
||
| Version control is the essence of engineering here at the Shed. Git is a free |
There was a problem hiding this comment.
"the Shed" -> "The Shed" 👍
| ## **Welcome!** | ||
|
|
||
| Version control is the essence of engineering here at the Shed. Git is a free | ||
| version control system that's responsible for everything GitHub related that |
There was a problem hiding this comment.
[git is] responsible for everything GitHub related
It's for everything git related. GitHub is just one of many git-based version control system.
| and commonly used Git commands for easy reference. | ||
|
|
||
| Full Git Techincal Guide can be | ||
| [here](https://github.com/TheDataShed/EngineeringHandbook/blob/main/guides/technical-guides/git.md). |
There was a problem hiding this comment.
Can this be swapped to a relative link, please? e.g. guides/technical-guides/git.md
|
|
||
| ## **Cheatsheet includes:** | ||
|
|
||
| 1. Installation & GUI |
There was a problem hiding this comment.
The list shouldn't be indented - it may confuse the renderer and turn this in to a code block, instead of an ordered list!
|
|
||
| Configuring user information used across all local repositories. | ||
|
|
||
| _Set a name that is identifiable you when review version history_. |
There was a problem hiding this comment.
I'd be tempted to swap these for the next level of headings, rather than an italicised string!
|
|
||
| _Set a name that is identifiable you when review version history_. | ||
|
|
||
| git config --global user.name “[firstname lastname]” |
There was a problem hiding this comment.
Whilst the 4-space indent does work for code blocks, it means we can't benefit from any syntax-highlighting offered by the renderer.
Better to swap these to be code blocks marked by three backticks, and a language hint e.g.
git config --global user.name "[firstname lastname]"
|
|
||
| _Set an email address_. | ||
|
|
||
| git config --global user.email “[valid-email]” |
There was a problem hiding this comment.
Can you swap the smart-quotes for vanilla double-quotes, please?
Copy-pasting the command in some terminals with those smart quotes will cause errors.
| matches or wildcard globs_. | ||
|
|
||
| You can navigate to the | ||
| [gitignore](https://www.toptal.com/developers/gitignore/) website where you can |
There was a problem hiding this comment.
Our git policies page suggests the use of https://www.gitignore.io/, so this should probably be consistent!
| @@ -0,0 +1,334 @@ | |||
| # Git Cheatsheet | |||
|
|
|||
|  | |||
There was a problem hiding this comment.
Not averse to the meme, but would be better to change the terminology from master to main as per: https://github.com/github/renaming#renaming-the-default-branch-from-master
Added Git folder and Git file cheatsheet.
Amended the errors.