-
Notifications
You must be signed in to change notification settings - Fork 8
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
Add GitHub guide #9
Conversation
Then point out that we're talking about the *example* again.
(Not that I use it much myself, but I think that this is how it should be used.)
The site is run by GitHub and presents a nice overview of license "features".
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I read through the document, clicked all of the links, fixed a few trivial issues, and left a couple of comments. Feel free to address as you see fit.
git-github-introduction.md
Outdated
You can check your user information by typing the following command: | ||
|
||
``` | ||
$ git config --list |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If you've used Git already on this machine, this command yields a long scary list of config items.
For checking just the user name and email, one could use git config --get-regexp user
git-github-introduction.md
Outdated
configuration if you use the global flag (as in the provided example). | ||
|
||
``` | ||
$ git config --global user.name "John Smith" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
An irrelevant BTW: Configuring user.name
seems to be optional, only the email address appears to be a mandatory config item. Also, the user name need not be your actual name.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I noted in the guide that the user.name
value is arbitrary, but it is customary to use your full name. I also decided to retain the user.name configuration since the official Git docs advise users to set it, and the error message one receives when a Git identity is unset asks for a user.name
.
https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup
git-github-introduction.md
Outdated
Fetching and merging the latest changes of `upstream` (remembering that the | ||
`upstream` alias points to the original repository) can be done with Git's | ||
`pull` command. The `pull` command fetches changes made to the remote | ||
repository and merges them into your local repository. Branches are multiple |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I suggest to break the paragraph and add a new subsection, "Branching".
git-github-introduction.md
Outdated
![GitHub Branches](/images/branches_sm.png) | ||
|
||
Additional information on [syncing a | ||
fork](https://help.github.com/articles/syncing-a-fork/) is recommended. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"recommended" as in "a recommended read"? Should this be, [The GitHub help](...) has more information on keeping your forks in sync with upstream
?
How can we help our newcomers to adopt Git quickly (to use it productively for their own work) and in a way that interfaces nicely with our workflows? Should we send newcomers to @octocat's Or shall we have a playground repo of our own where people can experiment? "First task on first day on the team: Add your favorite sports/treat/metro line to secure-systems-lab/playground" sorts of thing? |
How about something like this |
* Make it clear that the user.name is arbitrary * Change title from 'Configure User information' to 'Configure Git Identity'
@baloyan |
@aaaaalbert |
Thanks for addressing my concerns, @vladimir-v-diaz! |
Following secure-systems-lab#14, which removed 'git-github-introduction.md', this commit removes images referenced by that document. Both document and images is also available in the lab-guidelines repo (see secure-systems-lab/lab-guidelines#9).
@lukpueh and I thought it made more sense to have the Git+GitHub guide available on the lab-guidelines repo. This pull request addresses issue secure-systems-lab/code-style-guidelines/issues/13