intro.md

   1 # Git is ...
   2 Source Code Management (SCM) and it's great. Check out https://git-scm.com/ for
   3 details.
   4
   5 # Init - do it once per repository
   6 You may clone it like `git clone URL` or create one from a folder by `git
   7 init`.
   8
   9 Also, just after first commit, you may be asked to set up your name and email
  10 address with `git config ...` command. If `--global` is used the name and/or
  11 email will be automatically used for all the commits.
  12
  13 ## Command `git clone`
  14 Copy existing repository that is available online from some server to local
  15 directory.
  16 ```
  17 git clone ssh://git@rtime.felk.cvut.cz/hubacji1/oneflow.git
  18 ```
  19
  20 ## Command `git init`
  21 Initialize directory to be able to use git commands.
  22 ```
  23 git init
  24 ```
  25
  26 ## Command `git config`
  27 Setting up your name and email address is required at minimal.
  28 ```
  29 git config user.name "Your Name"
  30 git config user.email you@example.com
  31 ```
  32
  33 If the name and email should persist as default for any other git repository:
  34 ```
  35 git config --global user.name "Your Name"
  36 git config --global user.email you@example.com
  37 ```
  38
  39 # Explore - check out the repository history
  40 The command that show the whole history is `git log`. The history is build from
  41 commits - changes to files in row scale.
  42
  43 The changes of the commit can be shown by `git show COMMIT_ID`. Where the
  44 `COMMIT_ID` is the identifier obtained from `git log` command.
  45
  46 # Changes - check out before commit
  47 The status of the repository can be checked by `git status` command. This
  48 allows you to see *new files* that are not yet tracked, *changed files* whose
  49 changes are not yet ready to be commited to the log history and *changed files*
  50 that are ready.
  51
  52 The `git diff` command shows *changes* in not-yet-ready files and `git diff
  53 --cached` shows *changes* that are ready to be committed.
  54
  55 # Commit - build repository history
  56 You get ready the files to be commited to the history by `git add FILE`
  57 command. If you change your mind, you may `git reset FILE` that file.
  58
  59 If only huks of lines in file should be prepared for commiting to the history
  60 `git add -p FILE` and `git reset -p FILE` can be used respectively.
  61
  62 Before commiting to the history log check twice `git diff --cached` and `git
  63 diff`.
  64
  65 When sure that staged changes should be commited to the history, use `git
  66 commit -m'COMMIT MSG'`. For commit messages, some rules are good to keep in
  67 mind [1][]:
  68 - Separate subject from body with a blank line.
  69 - Limit the subject line to 50 characters.
  70 - Capitalize the subject line.
  71 - Do not end the subject line with a period.
  72 - Use the imperative mood in the subject line.
  73 - Wrap the body at 72 characters.
  74 - Use the body to explain what and why vs. how.
  75
  76 # Cheat sheet
  77 Use `git COMMAND --help` for showing the help!
  78
  79 ## Init
  80 - `git clone URL`
  81 - `git init`
  82 - `git config user.name "Your Name"`
  83 - `git config user.email you@example.com`
  84 - `git config --global user.name "Your Name"`
  85 - `git config --global user.email you@example.com`
  86
  87 ## Explore
  88 - `git log`
  89 - `git log --graph`
  90 - `git log --oneline`
  91 - `git log --decorate`
  92 - `git show COMMIT`
  93
  94 ## Changes
  95 - `git diff`
  96 - `git diff --cached`
  97
  98 ## Commit
  99 - `git add FILE`
 100 - `git add -p FILE`
 101 - `git reset FILE`
 102 - `git reset -p FILE`
 103 - `git commit -m'COMMIT MSG'`
 104 - `git commit`
 105
 106 [1]: https://chris.beams.io/posts/git-commit/