Git README.md

이유진·2024년 8월 13일

TIL

목록 보기
17/24

⭐ Git README.md 작성

개인과제를 시작하면서 IntelliJ와 Git을 연결하고 init commit 하고 push 하는데 오류가 계속 떴다..

오늘은 이 부분에 대한 나의 무지함을 회고하고 알아가는 시간을 가져보기로 한다~

tmi. 참고로 이거땜에 혼났다...

  • 먼저 README란?

    README 파일은 주로 Github 프로필 혹은 Repository에 대한 설명을 나타내기 위해 작성한다. README는 쉽게 말하면 가이드라인, 안내문 정도로 생각할 수 있다. 그 이유는 README 파일에는 일반적으로 프로젝트에 대한 정보가 담겨 있어, 소프트웨어 배포시에 함께 포함되는데, 이러한 점이 마치 새 제품을 샀을 때 읽어보는 사용 설명서와 비슷하기 때문이다.


  • 개인과제를 시작하면서 README에 API 명세서와 ERD를 올리라고 하셨다.

나는 README는 저 연필모양 버튼으로 들어가서 작성하는줄 알고 저기서 수정을 했더란다 ㅎㅎ

그 와중에 ERD 이미지가 제대로 안나와서 ''왜 이미지가 안올라가지지?'''하고 물어봐서 알게되었다!

지인 왈 : "너는 그럼 코드도 저기 들어가서 수정하지 왜"

알고보니 폴더에 있는 README 파일에서 수정하는 거였다,, 당연한거 일텐데 이제 깃을 써보는 나는 아무렇지 않게 저기서 수정을 했다..ㅎ

Git에서는 내가 수정해놓고 로컬에서는 당연히 수정을 안해놨으니 충돌이 일어나는 거였다.

  • 대망의 에러

→ 이 오류는 원격 저장소의 main 브랜치에 로컬에서 없는 변경 사항이 있을 때 발생한다.(README를 브랜치에서 작성했으니깐 당연^^)

→ 원격 저장소의 변경 사항을 로컬로 가져오고, 충돌을 해결 후 다시 푸시 해주면 된다!! (GPT가 알려줌)

<해결완료😊>


+) 커밋 컨벤션

  • Git commit convention이란?
    • Commit Convention은 쉽게 commit할 때 commit message에 대한 약속이라 봐도 무방할 것 같다. 과제 하면서 참고해서 적으면 좋을 것 같다!

profile
🙌중요한건 꺾였는데도 그냥 하는 마음

0개의 댓글