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

Clarifications #23

Open
15 tasks
iteles opened this issue Apr 7, 2015 · 0 comments
Open
15 tasks

Clarifications #23

iteles opened this issue Apr 7, 2015 · 0 comments

Comments

@iteles
Copy link

iteles commented Apr 7, 2015

Getting started

  • git clone and git status in 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' 😉

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 branch here here makes things a little unclear as it's the first time you're using git 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

Merging changes with master

Merge conflicts

  • git status should be code or a full sentence 😉

Git Flow

  • 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!)

Further Terminology

  • 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

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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant