Github - 001 - 2024년12월14일

• tag : Github |

Github

git bash 에서 아래 나오는 코드 실행하기

환경설정

• 정보 확인하기

$ git config --list

• 위 출력에서 없는 것을 확인한 후 추가

$ git config --global uesr.name "{username}"
$ git config --global user.email "{emaliaddr}"
$ git config --global core.editor "vim"
$ git config --global core.pager "cat"

• Tip

만약 core.editor 값이 vim, notepad 두 개가 있을 경우

$ vi ~/.gitconfig

위 명령어 입력 후 notepad부분을 지우고 저장 후 다시 $ git config –list 로 확인하기

깃허브 생성

• 단계
  1. 깃허브 접속
  2. create repository -> public 선택, Lisence : MIT 로 선택
  3. 주소 복사 후[HTML] git bash 에서 다음 명령어 입력

     git clone "주소"
     

깃허브 상태 확인 후 commit 까지

$ git status # 자주 확인해주는 것이 좋다.
$ git add {파일명.확장자}
$ git commit

$ git remote      # origin
$ git remote -v
$ git push origin main # origin[git remote으로 확인한 값]에 main branch로 올린다.

• 비밀 키 받기
  1. 오른쪽 맨 위 프로필 아이콘 클릭 -> Settings 클릭
  2. 왼쪽 사이드 바에서 Developer Settings 클릭
  3. 왼쪽 사이드 바에서 Personal access tokens 아래에 있는 Tokens(Classic) 클릭
  4. 오른쪽 위에 Generate new token 선택 후 Generate new token(classic) 선택

pre-commit

commit 수행 전 체크해야 할 것들을 자동 수행하도록 도와주는 도구
참고 사이트

$ pip install pre-commit (or $ pip3 install pre-commit) # 설치
$ pre-commit --version # 잘 설치되었는지 확인
$ pre-commit sample-config > .pre-commit-config.yaml # .pre-commit-config.yaml 파일 생성
$ cat .pre-commit-config.yaml # 내용보기

• 사용방법

  commit 하기 전에 사용

  $ pre-commit run
  $ pre-commit run -a # 이것을 주로 사용하는 것 같다.[개인적인 의견]
  

Branch

분기점을 생성하여 독립적으로 코드를 변경할 수 있도록 도아주는 모델

• branch 확인하기

$ git branch
$ git branch -r
$ git branch -a

• branch 생성

$ git branch {branch 이름} # branch 생성
$ git switch {branch 이름} # branch 전환
... { 여기서 branch에서 작업 add -> commit }
$ git switch main # main branch 로 전환
$ git merge {branch 이름} # main이 아닌 다른 branch 에서 작업한 것을 합치기
$ git branch -D {branch 이름} # branch 삭제

그 외

1. 보기좋은 로그 출력하기

   $ git config --global alias.lg "log --color --graph --pretty=format:'%Cred%h%Creset -%C(yellow)%d%Creset %s %Cgreen(%cr) %C(bold blue)<%an>%Creset' --abbrev-commit"
   

2. commit 메세지 작성하는 방법

   참고사이트

3. github repository 생성 사이트

   참고사이트

4. gitignore 파일 만들기

   참고사이트1
   참고사이트2

5. github에서 jupyter notebook 변경사항을 보고 싶을 때

   오른쪽 위 프로필 사진 클릭 -> Feature preview 클릭 -> Rich Jupyter Notebook Diffs 활성화

6. git 을 쓰면서 습관들이면 안되는 것

   > $ git add . : 현재 디렉토리 하위의 모든 파일을 staging할 때 사용.
   > but, 현재 commit단위에 들어가면 안되는 파일까지 휩쓸릴 수 있으므로 습관적으로 사용하면 안됩니다.
   > $ git commit -m "Message" : 쉘에서 바로 메시지를 쓰면서 커밋할 때 사용.
   > but, revert commit, merge commit 등의 상황에서 메시지를 덮어쓸 우려가 있으므로 습관적으로 사용하면 안됩니다.
   > 저장소 안에 저장소 clone 하기 : 프로젝트 단위는 항상 독립적으로 존재해야 합니다.
   > 의미없는 commit message 남기기(ex. a, 1, ..) : commit message는 제목만으로 해당 작업단위에 대한 설명이 가능해야 나중에 고생하지 않습니다.
   > Conventional commit 잘 지키기!!