learn-git-basics
learn-git-basics copied to clipboard
Clarifications
Getting started
- [ ]
git cloneandgit statusin this section need a little more clarification for beginners - what do these commands do? It would also be great to have a screenshot of the results so people know 'it's working' :wink:
Branching
- [ ] "name them off of a feature" - needs to be clearer, for example 'named for the feature you are working on or the bug you are fixing'. Maybe also encourage people to not be afraid to open branches for small fixes, it's still good practice!
- [ ] The
git branchhere here makes things a little unclear as it's the first time you're usinggit checkout- suggest splitting them out so people don't think you have to always use them together - [ ] Maybe move deleting a branch to further down the workflow or explain why you're deleting it here
Making Changes
- [ ] I know it seems obvious but I think it's worthwhile explaining that the -m flag is what allows you to add a message
- [ ] A couple of links on what vim is and a good external tutorial are useful in this section if you don't want to go into what vim is here
Merging changes with master
- [ ] Needs a few words on what making a pull request means
Merge conflicts
- [ ]
git statusshould becodeor a full sentence :wink:
- [ ] A couple of words added to explain git flow is a workflow (so people aren't forced to open the links and break the flow of the tutorial - no pun intended!)
- [ ] This section feels a little disjointed to me here (I would expect 'Further anything' to come at the end of a tutorial), maybe just needs a little clarification, i.e. 'Further terminology you will need for this section'
Timeline
- [ ] "Before we start make sure you have a terminal open located at the local copy of this repo." - The wording here is a bit confusing
- [ ] "Repeat step 2 twice more" - if you're going to refer to steps, it might be worth actually splitting the tutorial into steps; often makes it easier to follow along!
- [ ] "copy the hash" - worth clarifying this is essentially the ID number of the commit
Commit messages
- [ ] "Present tense for your commit messages" - example?
- [ ] "If related to an issue on github, should contain issue number" - if you put the issue url into the commit message, a comment will automatically be added to your issue referencing the commit