-
Notifications
You must be signed in to change notification settings - Fork 67.3k
Some omissions in "GitHub flow" #23727
Copy link
Copy link
Closed as not planned
Labels
contentThis issue or pull request belongs to the Docs Content teamThis issue or pull request belongs to the Docs Content teamstaleThere is no recent activity on this issue or pull requestThere is no recent activity on this issue or pull requesttriageDo not begin working on this issue until triaged by the teamDo not begin working on this issue until triaged by the team
Description
Metadata
Metadata
Assignees
Labels
contentThis issue or pull request belongs to the Docs Content teamThis issue or pull request belongs to the Docs Content teamstaleThere is no recent activity on this issue or pull requestThere is no recent activity on this issue or pull requesttriageDo not begin working on this issue until triaged by the teamDo not begin working on this issue until triaged by the team
Type
Fields
Give feedbackNo fields configured for issues without a type.
Code of Conduct
What article on docs.github.com is affected?
https://docs.github.com/en/get-started/quickstart/github-flow
What part(s) of the article would you like to see updated?
In the "Make changes" section:
It says "On your branch, make any desired changes..." but gives no indication of how to make a change on the branch. It would be helpful to have a brief description here of the "checkout" command (which I have now been told is the way to do this).
It says "Commit and push your changes to your branch". A brief mention here of what commit and push do would be useful. E.g. ("commit" registers locally the changes that you have made; "push" copies them to the repo enabling other users to see them.)
(I am a Github newbie, so I may have got that description wrong.)
In "Create a pull request", it would be useful to some text explaining what a pull request is. E.g. A pull request is how you tell the repo owner that there is a change that would like to have incorporated.
(Again, that may not be quite correct.)
Additional information
No response