Skip to content

Git guide

What is git

TODO

Structure of a git project

    gitGraph TB:
       commit
       commit
       branch feature/smth
       commit
       checkout main
       commit
       branch feature/smth2
       commit
       checkout feature/smth
       commit
       checkout main
       merge feature/smth
       checkout feature/smth2
       commit
       checkout main
       merge feature/smth2

Submodules

TODO

Usage of git in shamrock

Resemble to gitflow:

gitGraph LR:
  commit
  commit
  commit
  branch feature/something
  checkout main
  commit
  checkout feature/something
  commit
  commit
  commit tag: "Open Pull request"
  checkout main
  commit
  checkout feature/something
  checkout main
  commit
  merge feature/something tag: "Merge pull request"

Open a branch called, feature/..., doc/..., whatever as long as it's clear. Do your changes, and then open a pull request.

Cloning a repository

To clone a repository and its submodules 

git clone --recurse-submodules git@github.com:Shamrock-code/Shamrock.git

Git configuration

Username and mail : 

git config --global user.name "<github username>"
git config --global user.email "<github email>"

Default editor :

git config --global core.editor nano

git config --global core.editor vim

Making a commit

First go on the branch your are working on : 

git fetch --all
git checkout <branch name>

Do your changes then :

git add <files that were modified>
git commit -m "my commit message"
git push

For the commit message please name them accordingly : [<Modified component>] <the commit message>, for exemple [SPH] fix ....