GitHub 연동/활용하기

남규이·2021년 12월 31일
0

공부 하는 Q_E

목록 보기
5/5
post-thumbnail
post-custom-banner

📌 사용할 개발도구(IntelliJ) 설치하기


  • 해당 폴더에 있는 하위 bin폴더에서 startup.bat 파일을 실행하면 http://localhost:포트번호(8000)에 접속하여 위 그림과 같이 출력되면 정상적으로 톰캣이 설치, 실행되고 있다는 것을 의미한다.

<참고>
유튜브 JavaCampus_IntelliJ IDEA 다운로드 및 설치


📌 개발도구(intellij)와 Git 연동하여 Push하기


1. Github에서 새 레포지토리를 생성 후, 연동

  • 새로운 프로젝트를 하나 생성한다. java파일로 하나 생성하고 프로젝트명과 파일명을 지정해준다. 또한 Github에 새로운 레포지토리를 생성하여 준비한다.

  • 상단바에서 File > Settings > Plugins 에서 installed 탭으로 이동하여 Git과 Github가 설치되었는지 확인한다.


  • 상단바에서 File > Settings > Version Control > Git
    Path to Git executable 에서 git 실행파일을 선택하고 Test를 클릭하여 실행되는지 확인한다.

  • 상단바에서 File > Settings > Version Control > Github ➕ 버튼을 클릭하여 GitHub 계정을 입력하여 로그인한다. 연결된 계정을 클릭하고 ✔ 를 클릭하면 해당 계정이 디폴트로 설정된다.

  • 위를 실행하고 Remote Repository 등록해준다.
    상단바에서 VCS > Enable Version Control Integration Git 선택 후 OK, 해당 프로젝트 파일이 Git의 관리에 들어간것을 확인한다.

  • 해당 프로젝트에 우측 키 > Git > Add 하고 상단 바에서 Git > Commit을 진행해준다.
    빨간색으로 표시된 파일들이 초록색으로 변경된다.

< 파일 상태별 색상 >
빨간색 - add 되지 않은 파일
초록색 - add 된 파일
파란색 - 수정된 파일
하얀색 - commit 된 파일
회색 - 삭제된 파일

  • 커밋해줄 파일들을 선택하고 커밋 메세지를 작성한 후 Push까지 가능한 Commit and Push를 클릭한다.

  • Push를 해주면 좌측 Commit 탭에서 Project탭으로 넘어와 파일 상태색상이 흰색인걸 확인했고 Github에 들어가면 올라간것을 볼수있다.

2. IntelliJ에서 새 레포지토리를 생성 후, 연동

  • CTRL + SHIFT + A를 누르고 "share project github"를 검색하여 들어가면 Github로그인 창으로 로그인(첫시작 시)을 해주거나 상단바에서 VCS > Share Project on GitHub로 로그인(첫시작 시)한다.

  • share를 해주면 Add및 Commit을 할수 있는 창이 자동을 뜬다. 커밋메시지를 작성하고 커밋해주면 Github에 올라간것을 볼수있다.

  • 이후, 새로 추가하여 Add까지 된 파일은 초록색, 수정된 파일은 초록색, Add를 못한 파일은 빨간색, 삭제한 파일은 회색, Commit된 파일은 흰색으로 확인된다.

  • 동일하게 해당프로젝트 우클릭 > Add를 한 후, 상단 바에서 Git > Commit을 해주고 커밋메시지를 작성하여 Push and Commit을 해준다. Github에 올라간것을 볼수있다.

<참고>
mina7523 네이버블로그_IntelliJ와 Github 연동

📌 Commit 작성 규칙에 맞춰 사용하기


🔍 규칙에 맞는 좋은 커밋메시지를 작성해야 하는 이유는?

  1. 팀원과의 소통
  2. 편리한 과거의 기록 추적
    즉, 협업 관련하여 서로 보다 효율적이고 편리하게 해주는 기본 매너이기에 어렵더라도 지켜서 사용하는 습관을 키워야한다!
       ↪ <사용 방법> 명령어에 옵션없이 git commit을 입력하고 Vi 입력창에 아래의 규칙을        따라 커밋 메시지를 작성하면 된다.
    1. 커밋 유형 지정

FEAT : 새로운 기능에 대한 커밋
FIX : 버그 수정에 대한 커밋
DOCS : 문서 수정에 대한 커밋
BUILD : 관련 파일 수정에 대한 커밋
STYLE : 스타일 관련 기능(코드 포맷팅, 세미콜론 누락, 코드 자체의 변경이 없는 경우)
REFACTOR : 코드 리펙토링에 대한 커밋
TEST : 테스트 코드, 리펙토링 테스트 코드 수정에 대한 커밋
CHORE : 빌드 업무 수정, 패키지 매니저 수정(ex .gitignore 수정 같은 경우)
CI : CI 관련 설정 수정에 대한 커밋

  1. 제목과 본문을 빈 행으로 분리

  1. 제목 행을 50자로 제한

강제로 제한하는 것은 아니고 읽기 쉽고 간결하게 표현하기 위한 경험에 의한 규칙이다

  1. 제목 행의 첫 글자는 대문자로 시작

readme file modification X
Readme file modification O

  1. 제목 행 끝에 마침표를 넣지 않는다

제목 행의 끝에는 마침표가 필요 없다.
50자 규칙에 따르기 위해서라도 마침표를 넣는 것은 불필요한 공간 낭비이다

Open the door. X
Open the door O

  1. 제목 행에 명령문을 사용한다

"명령이나 설명하듯이 작성"

네 방을 치운다 (Clean your room)
문을 닫는다 (Close the door)
쓰레기를 갖다 버린다 (Take out the trash)

  1. 본문은 72자마다 끊어 줄을 바꿔준다.
  1. 본문을 사용하여 변경 한 내용과 이유 설명(어떻게 보다는 무엇과 왜를 설명한다)
  1. 검토자가 원래 문제가 무엇인지 이해한다고 가정하지 말고 확실하게 설명 추가
  1. 자신의 코드가 직관적으로 바로 파악 할 수 있다고 생각하지 말자
  1. 팀에서 정한 Commit 규칙을 따르자

<참고>
richone tistory_깃 커밋 메시지 작성법
xtring-dev tistory_깃 커밋 메시지 작성법

profile
기록하는 습관
post-custom-banner

0개의 댓글