[Git] GitHub 정리하기

Ronie🌊·2021년 3월 20일
6

Git🌊

목록 보기
1/2
post-thumbnail

이번에 github를 한번 정리해봤습니다. 평소에는 github에 무턱대고 repository올리고 대충 정리한 규칙으로 commit해서 github가 완전 엉망이더라구요...
그래서 한번 정리할 겸 포스팅 해봅니다!


index

1. Repository 합치기
2. github commit 규칙 정하기
3. github profile readme 꾸미기


Repository 합치기

  • Java나 Python공부한 내용을 라이브러리 별로 repository를 나눠놨었는데요. 이게 너무 잡다해 보여서 한곳의 repository로 합쳐서 관리해보려고 했습니다.

합치기전에 우선 한곳에 모을 Repository를 만듭니다.

git clone (repository 주소) 

clone한 local repository에 첫번째 commit해줍니다.

commit을 안하면 추후 subtree를 진행할때 git diff-index HEAD가 내부적으로 수행하게 되어서 commit이 없으면 에러가 난다고 합니다!

readme수정
git add . 
git commit -m [설명]

subtree로 repositroy병합하기

git subtree add --prefix=(해당 Repository 하위의 디렉터리명) (옮겨올 Repository 주소) (옮겨올 Repository의 branch) 

병합한 repository 삭제?

삭제해도 되고 삭제안해도 됩니다!
하지만 병합하는 목적이기때문에 삭제했습니다!
삭제는 github의 repository설정페이지에서!

참조
yeoseon님이 자세히 설명해주셨습니다. 그냥 복붙한거나 다름없는...ㅠㅠ
http://yeoseon.kr/git-repository-habcigi-commit-log-yuji-subtree-iyong/


github commit 규칙 정하기

규칙은 종류가 되게 많더라구요. 그중에 가장 깔끔해보이고 잘 정리된 포스팅을 참조했습니다!

commit 규칙

type(타입) : title(제목)

body(본문, 생략 가능)

Resolves : #issue, ...(해결한 이슈 , 생략 가능)

See also : #issue, ...(참고 이슈, 생략 가능)

type

  • feat : 새로운 기능 추가
  • fix : 버그 수정
  • docs : 문서 수정
  • style : 코드 formatting, 세미콜론(;) 누락, 코드 변경이 없는 경우
  • refactor : 코드 리팩토링
  • test : 테스트 코드, 리팽토링 테스트 코드 추가
  • chore : 빌드 업무 수정, 패키지 매니저 수정

title

  • 제목은 50자를 넘기지 않고, 마침표를 붙이지 않는다.
  • 제목에는 위 커밋 종류를 함께 쓴다.
  • 과거시제를 사용하지 않고 명령조로 작성한다.
  • 제목과 본문은 한 줄 띄워 분리한다.
  • 제목의 첫 글자는 반드시 대문자로 쓴다.
  • 제목이나 본문에 이슈 번호(가 있다면) 붙여야 한다.

body

  • 선택사항이기에 모든 커밋에 본문 내용을 작성할 필요는 없다.
  • 한 줄에 72자를 넘기면 안된다.
  • 어떻게(How)보다 무엇을, 왜(What, Why)에 맞춰 작성한다.
  • 설명뿐만 아니라, 커밋의 이유를 작성할 때에도 쓴다.

Resolves, See also

  • Issue Tracker ID를 작성할 때 사용한다.

자주쓰는 영어 표현

  • Fix typo
    오타수정
  • Fix A in B
    B의 A를 수정합니다
  • Fix A which B, Fix A that B
    B절인 A를 수정합니다

...
너무 많네요..commit할때마다 Reid님의 포스팅을 참조하다보면 익숙해..지 겠죠?

참조
https://velog.io/@djh20/Git-%EC%A0%9C%EB%8C%80%EB%A1%9C-%EC%82%AC%EC%9A%A9%ED%95%B4%EB%B3%B4%EC%9E%90
https://blog.ull.im/engineering/2019/03/10/logs-on-git.html
https://underflow101.tistory.com/31


github profile readme 꾸미기

꾸미는것도 다른 포스팅이 무척많더라구요! 그중에 저는 가장 이쁘게 꾸미신 wookyoungKim님의 포스팅을 복붙했습니다;

profile용 readme repository만들기

자신의 github 계정이름과 똑같이 만들면됩니다!
(found secret! 이스터에그를 발견한 느낌 ㅎㅎ)

README.md 수정하기

마크다운 작성시에 preview사이트를 이용하시거나 하던데
저는 visual studio code에 있는 md프리뷰기능을 사용합니다.

Markdown Preview

간단히 md파일에 오른쪽클릭을 하게되면!

작성하면서 자동적으로 preview됩니다!

Markdown 수정

헤더부분

![header](https://capsule-render.vercel.app/api?type={헤더타입}&color={색상}&height={높이}&section=header&text={텍스트}%20render&fontSize=90)

배지와 아이콘


참고로 아이콘은 안먹히는 아이콘이 있더라구요 그런거는 그냥 텍스트만이라도~

<img src="https://img.shields.io/badge/{텍스트내용}-{hexcolor}?style=flat-square&logo={logo이름}&logoColor={logoColor}"/></a>&nbsp 

이모티콘🐵 🙈 🙉 🙊

이모티콘하면 역시 이 사이트죠!
https://getemoji.com/

다양한 오픈소스들

조회수 확인이나, stats, 코딩시간기록 등 다양한 오픈소스가 있습니다! 하지만 일단 지금은 이것으로 충분히 만족하니깐!

참조
https://velog.io/@woo0_hooo/Github-github-profile-%EA%B0%84%EC%A7%80%EB%82%98%EA%B2%8C-%EA%BE%B8%EB%AF%B8%EA%B8%B0

후기🖐
특히나 이런 종류의 포스팅은 다른 분들의 포스팅을 거의 복붙하는 수준이라 너무 죄송하네요ㅠㅠ 참조는 잘 명시하고 있지만.. 아니 애초에 너무 완벽한 포스팅들이 많아요..저도 열심히 해서 완전 새로운 포스팅! 도전하겠습니다!

2개의 댓글

comment-user-thumbnail
2022년 2월 20일

안녕하세요 좋은 포스팅 잘 읽었습니다. 그런데 yeoseon님을 참조했다는 본문 내용의 링크에 문제가 있는 것 같습니다.

답글 달기
comment-user-thumbnail
2022년 6월 14일

굳굳! 이걸로 제 깃허브도 깔끔해지겠네요!

답글 달기