# commit message

25개의 포스트
post-thumbnail

원활한 협업을 위한 깃허브 커밋 메세지 올바른 작성법

안녕하세요, 주인장입니다! 타 개발자들과의 원활한 협업을 위한 commit 규칙을 정리해두었습니다.🧐 🧾 Formats for Commit Messages 먼저 커밋 메시지는 크게 제목, 본문, 꼬리말 세 가지로 나뉘고, 각 파트는 공백 줄로 구분합니다. 🔖 Message Tag 타입은 태그와 제목으로 구성되고, 태그는 영어로 작성, 첫 문자는 대문자로 합니다. "태그: 제목"의 형태이며, : 뒤에 공백을 넣어주세요. ▫️ Commit Message Subject 규칙 첫 글자는 대문자로 입력하고, 제목 줄을 마침표로 끝내지 않는다. 마지막에는 .(period)을 찍지 않으며 영문 기준 최대 50자를 넘지 않는다. 제목은 동사원형을 사용해 명령문의

2023년 7월 15일
·
0개의 댓글
·

commit message

커밋 메시지 작성 커밋은 기능단위로 !! 커밋 타입 : 동작 이름/함수 이름 * 예시 * 기능 예시 Feat : 새로운 기능 추가 Fix : 버그 수정 Env : 개발 환경 관련 설정 Style : 코드 스타일 수정 세미 콜론, 들여쓰기 등의 스타일적인 부분만 css 관련 : Design Refactor : 코드 리팩토링 (더 효율적인 코드로 변경 등) Design : CSS 등 디자인 추가/수정 Comment : 주석 추가/수정 Docs : 내부 문서 추가/수정 Test : 테스트 추가/수정 Chore : 빌드 관련 코드 수정, 자잘한 수정(기타 변경) Rename : 파일 및 폴더명 수정 Remove : 파일 삭제 * 7가지 메세지 규칙을 지킵니다. (출처: https://cbea.ms/git-commit/) 제목과 본문은 한 줄을 띄워서 작성

2023년 7월 14일
·
0개의 댓글
·
post-thumbnail

[Webstorm, intellij] 커밋 취소, 커밋 메시지 수정

이전에 vscode 환경에서 git 을 사용할 때는 일일히 터미널에 git add, commit, reset 등 명령어를 입력하여 관리했었다. 하지만 webstorm 편집기를 사용한 이후, 현재 저런 명령어들을 칠 필요없이 간편하게 git 을 다룰 수 있다. 이런 편리한 기능들을 모른채 명령어를 쳐왔는데, 마우스 클릭하나면 명령어들을 대체할 수 있었다.💪 git log 창은 다음과 같이 열 수 있고, 해당 로그에서 내가 커밋한 내역을 살펴볼 수 있다. webstorm(Intellij) 의 하단 툴바에서 “Git” 탭을 선택 “Log” 탭을 클릭 후 Git 로그 열기 ⚠️ 주의 주의해야할 점이 있는데, undo commit 과 커밋메시지 변경(amend)은 **이미 pu

2023년 6월 1일
·
0개의 댓글
·

Git - commit message

git 초보자인 나는 늘 commit messae를 어떻게 써야하나 고민하기 때문에 이렇게 정리하게 되었다. commit message 구조 > type(타입) : title(제목) body(본문, 생략 가능) Resolves : #issueNo, ...(해결한 이슈 , 생략 가능) See also : #issueNo, ...(참고 이슈, 생략 가능) |타입|사용 시점 | |------|------| |feat|새로운 기능 추가| |fix|버그 수정| |docs|문서 수정| |style|코드 스타일 변경| |design |사용자 UI 변경| |test|테스트 코드, 리팩토링 테스트 코드 추가| |refactor|코드 리팩토링| |build|빌드 파일 수정| |ci|CI 설정 파일 수정| |perf|성능 개선| |chore|빌드 업무 수정, 패키지 매니저 수정| |rename|파일 혹은 폴더명 수정| |remove|파일 삭제|

2023년 5월 13일
·
0개의 댓글
·
post-thumbnail

개발규칙 정하기

happyhouse는 개인프로젝트가 아니라 팀프로젝트이기에 분명 규칙이 정해져 있어야 프론트와 백간의 협업, 그리고 프론트 내부에서의 협업이 원활하게 이뤄진다. 1. issue생성하기 issue를 생성하기위해서 깃헙 프로젝트의 issue탭을 클릭한 후 우측상단의 New Issue를 눌러주면 다음과 같이 이슈 작성페이지가 뜬다. 이때 title를 정해야하는데 팀원들과 회의끝에 꼭 들어가야하는 3가지를 간추려봤다. 프로젝트의 version front와 back의 구분 개발할 기능 위 3가지를 합쳐 만든

2023년 2월 20일
·
0개의 댓글
·

커밋메시지에 자동으로 지라 이슈번호 넣기(with Python)

set git hook prepare-commit-msg with Python 이 작업은 동료가 만들었던 쉘스크립트로 된 비슷한 작업과 도움 덕분에 가능했습니다. 삽질의 시작 동료가 설명/설정해준 방법을 이용해 커밋메시지에 자동으로 지라 이슈번호를 잘 넣고 있던 어느날, 제가 맥북을 포맷하는 사태가 일어났습니다. (당연히) 로컬에 설정돼있던 파일이 다 날아갔고, 이 참에 제가 쓰는 커밋메시지 양식에 맞춰서 다시 git hook을 세팅하려고 마음 먹었습니다. 그렇게 삽질을 하게 될 줄은 꿈에도 모른 채… 에디터(VSCode 등)로 prepare-commit-msg 편집하기 저는 vi에 익숙하지 않아서 에디터로 열었습니다. 터미널 로컬 imweb 레포에서 cd .git/hooks : .git/hooks 폴더로 들어갑니다. cp prepare-commit-msg.sample prepare-commit-msg : prepare-commit-ms

2023년 1월 11일
·
0개의 댓글
·

커밋 메시지 작성법

Commit Messages Message Structure >type: Subject body footer type feat: 새로운 기능 fix: 버그 픽스 docs: 문서 수정 style: 코드의 변화와 관련이 없는, 포맷이나 세미콜론을 놓친 것 등 refactor: 코드 리팩토링 test: 테스트를 더하거나, 테스트 리팩토링 chore: build와 관련된 부분, 패키지 매니저 설정 등, production 코드와 관련 없는 것들 subject 50자 이하 대문자로 시작하고, 마침표로 끝나면 안 됨 명령형 문장 body (선택) 커밋에 약간의 설명과 컨텍스트가 필요한 경우에 사용 커밋의 내용과 이유를 설명하기 위해 사용 각 줄의 길이를 72자 이내로 제한 footer (선택) 이슈 추적 ID

2022년 12월 10일
·
0개의 댓글
·
post-thumbnail

[Git, Github] git commit message 자세히 작성하기

git commit 커밋 메시지에서는 어떤 작업을 했는지 누구나 알 수 있도록 커밋 메시지를 작성해야 합니다. 하나의 커밋에는 하나의 작업단위가 담길 수 있도록 해야 합니다. commit convention 개발 팀원들끼리 개발 설정을 정해놓는 방식을 말합니다. commit message convention 널리 사용되는 커밋 메시지 작성 방식을 말합니다. 작성 형식 예시 > git commit을 통해서 vim에서 commit message내용을 자세히 작성할 때 사용합니다. Type |타입| 설명| |-|-| |feat| 새로운 기능 추가| |fix| 버그 수정| |docs| 문서 수정| |style| 공백, 세미콜론 등 스타일 수정| |refactor| 코드 리팩토링| |perf| 성능 개선| |test| 테스트 추가| |chore| 빌드 과정 또는 보조 기능(문서 생성기능

2022년 11월 30일
·
0개의 댓글
·

commit-message

개요 일관성 있는 커밋 메세지 작성을 위한 포스팅 메세지 구조 > type: Subject > > > body > > footer > type : feat: 새로운 기능 fix: 수정 docs: 문서 변경 사항 style: 서식 지정, 세미콜론 누락 등 코드 변경 없음 refactor: 프로덕션 코드 리팩토링 test: 테스트 추가, 테스트 리팩토링; 생산 코드 변경 없음 chore: 빌드 작업 업데이트, 패키지 관리자 구성 등 생산 코드 변경 없음 subject 50 자 이내의 마침표가 없는 명령형 문장 body 설명과 컨텍스트가 필요할 경우 선택적으로 작성 내용과 이유 가 아닌 방법을 설명 한줄에 72자 이내 footer reference issue tracker 용도로 선택적으로 사용 참조 링크 [Ud

2022년 10월 27일
·
0개의 댓글
·
post-thumbnail

팀으로 일하는 법, 개발자의 기본기 (1) : Code Convention with Git & Github

❗ 코드 컨벤션이 필요한 이유 유지보수, 기능 고도화는 꼭 해당 코드를 작성한 사람만 하는 것이 아니다. 팀 이동, 혹은 이직을 통해 새로운 환경의 코드를 만날 수도 있다. 개발을 하면서 수없이 다른 사람의 개발 코드를 만나고 이해해야한다. 이때, 생산성을 높이기 위해 코딩 컨벤션을 준수해야한다. 💬 컨벤션을 정하면서 느꼈던 점 SI 업체에서 3년 씩이나 일을 했으면서도 컨벤션을 처음 설정해봤다. 웹개발이 주력인 회사가 아니었을 뿐더러 본인이 맡은 프로젝트는 끝까지 본인이 책임졌기 때문에(평균 근속 연수 약 4년) 코드를 공유 할 일이 많이 없었어서 그랬던 것 같다. 그나마 과장님과 내가 웹개발을 도맡아 하면서 코드를 공유했었는데, 당시에는 변수명 정도만 정했어서 코드 수정 후

2022년 10월 26일
·
0개의 댓글
·
post-thumbnail

<Weekly Log> 2022-32 Week

지난주 회고 개발 측면 > Front end 로직 작성 및 제작 Front end를 만들기 위해서 Vue로 프로젝트 구성을 하던 도중 강의 내용에서는 Vue2.0으로 제작했지만, 현재 프로젝트는 대부분이 Vue3.0으로 제작되어지므로 일부분 수정의 필요성을 느끼게 되었다. Vue3.0 Reference를 살펴보면서 프로젝트를 3.0으로 만들고, Github에 업로드하고 있다. 프론트 엔드 Github 주소 프론트 엔드 진행사항은 Back end의 Tester 회원가입 기능 기능을 사용할 수 있도록 form을 제공하고 back end로 요청을 보내고 응답을 받는 것 까지 확인할 수 있었다. > Backend 로직 작성 Front end 작성되는 부분에 따라 Back end 로직에서 필요한 부분과 필요없는 부분을 분리해볼까 했는데, 진행할 시간이 없어

2022년 8월 15일
·
0개의 댓글
·
post-thumbnail

이미 PR open 된 브랜치의 커밋 메세지를 변경해도 될까 (궁금하면 해본다 시리즈)

궁금하면 해본다 시리즈 1탄 > 결론부터 말하면 되긴 된다. 조건부로. > 이미 누가 해당 브랜치를 받아 작업을 진행했다면 깃이 (심각하게) 꼬일 수 있다. > 근데 왠만한 경우 머지 되기 전에 해당 브랜치에 이어 작업하는 경우는 없으므로 괜찮지않을까? 목차 글 쓴 이유 테스트 결과 글 쓴 이유 사이드 프로젝트를 코틀린 + 스프링 조합으로 진행하던 도중, 마침 line에서 만든 코틀린 jpa 라이브러리인 Jdsl을 알게 되어 접목해보았다. (링크 : https://github.com/line/kotlin-jdsl) 사용해보다가 운 좋게 컨트리뷰트 해 볼 만한 것이 생겼고, 희희낙락하며 pr을 날렸는데 dog고수분들의 무수한 악수변경 요청을 받았다. 몇 일동안 열심히 작업 진행 후 드디어 approve를 받아 github action이 돌았는데, commit lint가 뺀찌를 놨다. ![이게뭐꼬](https://velog.velcdn.c

2022년 8월 6일
·
0개의 댓글
·
post-thumbnail

[Git, Github] 좋은 commit message 작성하기

0. 순서 > commit을 하기 위한 순서 1-1. 코드 작업 1-2. git add (수정한 폴더) 1-3. git commit(1가지 선택) 1-4. git push 1-5. 코드 업로드 완료! git commit convention 2-1. commit convention을 사용하는 이유 2-2. commit convention을 적용하는 방법 Example Reference 1. commit을 하기 위한 순서 1-1. 코드 작업 1-2. git add (수정한 폴더) 1-3. git commit(1가지 선택) &nbsp&nbsp&nbsp&nbsp -m 을 이용하여 내용 작성하기 &nbsp&nbsp&nbsp&nbspgit commit 을 이용하여 commit message 작성하기 다음과 같은 화면이 출력된다. <img src="https://velog.velcdn.co

2022년 7월 6일
·
0개의 댓글
·
post-thumbnail

6/27 3일차

오늘은 백엔드 분들의 API 명세서를 기다려야하기 때문에 프론트엔드끼리 기능 구현 전 마무리를 짓기로 했다! 오늘 할 일 내가 맡은 파트의 자료조사 Github commit message rule 조사 Github branch pattern 조사 소셜 로그인(OAuth) --> 서버사이드, 클라이언트 사이드 조사 로그인 회원가입 React hook form 조사 프론트엔드끼리 어떤 폼을 사용할지 통일 beautify, prettier 차이 조사 후 결정 'styled component / tailwind + css 모듈' 조사 후 결정 카멜케이스 (js 주로 사용) 탭 사이즈 (2 size) CI, CD 연결 : CI, CD 연결방법 자료조사 > # 1. Tailwind + CSS 모듈 Tailw

2022년 6월 27일
·
0개의 댓글
·

작은 습관들이기

커밋 메세지 최근에 다시 github에 대해 다시 공부를 하면서(사실 그때 그때 찾아만 봤지, 제대로 시간을 내서 이해하는 과정은 없었다) 자료들을 읽으며 바로 적용 할 수 있는 부분들을 안드로이드 스튜디오를 통해 찾아봤다. 일단 문서나 블로그에서 찾아 볼 수있는 공통적인 부분들은 다음과 같다: 커밋메세지는 짧고 간략하면서 커밋의 내용을 다 포함 할 수 있으며 다른 사람도 보고 이해하기 쉽게. 알잘딱깔센? 사실 혼자 개발하는 입장에서 그냥 주구장창 내가 뭘 했고 뭘했는지 다 쓰면 나는 편하겠지만 결국 한 회사에서 같이 협업을 하는 입장이라면 이 구구절절 다 써도 상관없다는 안일함은 더 이상 통용되지 않는다. 그래서 좀 찾다보니, 컨벤션 중에 하나가 글자수 제한이라는 문구가 들어왔다. 흠... IDE에서 글자수를 제한 하고 커밋을 못하게 하면 아주 좋겠군?? 하고 역시나 찾아봤는데 있었고, 요즘은 이 기능을 사용해서 강제적으로 커밋메세지를 더 생각하게 하고 어떻

2022년 5월 11일
·
0개의 댓글
·
post-thumbnail

[Git] commit convention (type: subject의 중요성)

commit은 버전을 확정 시키는 작업이지요 여러분들은 commit시 message를 어떻게 남기시나요? 누군가 정해주지 않더라도 경험상 체득할 수 있습니다 "왜", "언제"에 대한 이유는 경험상 알고있기에 "어떻게"에 대해 공유해보겠습니다 다음 사진은, 알고리즘 공부의 기록을 위한 commit 입니다 unidentify message버전의 관리가 필요없고, 기록만을 위한 commit이기에 문제가 없지만 project에서는 경우가 다릅니다 여러개의 commit message가 쌓여있을때 원하는 버전으로 가기 위해서 commit을 확인해야하는데 message가 저렇다면 식은땀이 나겠죠? 어떻게 그럼 commit시 message는 어떻게 남기는게 좋을까요? 당연하게도 해당 버전을 유추할

2022년 4월 17일
·
0개의 댓글
·
post-thumbnail

Git 커밋 메시지 컨벤션

Commit Message Structure 제목 / 본문 / 꼬리말로 구성한다. Commit Type feat: 새로운 기능 추가 fix: 버그 수정 docs: 문서 수정 style: 코드 포맷팅, 세미콜론 누락, 코드 변경이 없는 경우 refactor: 코드 리팩토링 test: 테스트 코드, 리팩토링 테스트 코드 추가 chore: 빌드 업무 수정, 패키지 매니지 수정 Subject 제목은 50자를 넘기지 않고, 대문자로 작성하고 마침표를 붙이지 않는다. 과거시제를 사용하지 않고 명령어로 작성한다. "Fixed" --> "Fix" "Added" --> "Add" Body 선택사항이기 때문에 모든 커밋에 본문내용을 작성할 필요는 없다. 부연설명이 필요하거나 커밋의 이유를 설명할 경우 작성해준다. 72자를 넘기지 않고 제목과 구분되기 위해 한칸을 띄워 작성한다

2022년 3월 25일
·
0개의 댓글
·

[Git] Commit Message Rules

Intro commit message를 잘 쓰기 위해서 노력해야하는 이유는 잘 쓰인 커밋 메세지가 더 유익하다는 점을 많은 프로그래머들이 공감한다고 한다. 대표적인 장점으로 3가지가 있다. > 1. 커밋 로그 가독성 더 나은 협엽과 리뷰 프로세스 더 쉬운 코드 유지보수 Commit Msg feat : 새로운 기능 fix : 버그 수정 docs : documentation 변경 style : 코드 의미에 영향을 주지 않는 변경사항 (fomatting, colons etc) refactor : 버그 수정, 기능 추가가 아닌 코드 변경, 리팩토링 test : 누락된 테스트 추가 또는 기존 테스트 수정 **chor

2021년 10월 20일
·
0개의 댓글
·
post-thumbnail

Git 커밋 메시지 컨벤션

Commit Message Structure 제목 / 본문 / 꼬리말로 구성한다. Commit Type feat: 새로운 기능 추가 fix: 버그 수정 docs: 문서 수정 style: 코드 포맷팅, 세미콜론 누락, 코드 변경이 없는 경우 refactor: 코드 리팩토링 test: 테스트 코드, 리팩토링 테스트 코드 추가 chore: 빌드 업무 수정, 패키지 매니지 수정 Subject 제목은 50자를 넘기지 않고, 대문자로 작성하고 마침표를 붙이지 않는다. 과거시제를 사용하지 않고 명령어로 작성한다. "Fixed" --> "Fix" "Added" --> "Add" Body 선택사항이기 때문

2021년 10월 13일
·
0개의 댓글
·
post-thumbnail

TIL 28. Git&Github 깃 터미널 명령어와 커밋 메시지 작성법

깃 터미널 명령어 (Git Command Line) > 깃이 제공하는 수많은 터미널 명령어와 옵션을 확인 하는 방법을 알아보자. 쉽고 빠르게 명령어를 찾고 싶다면 git cheat sheet를 검색해보자. 다양한 git 명령어 확인하기 환경설정 로컬 파일 상태 확인하기 커밋하기 아직 push되지 않은 마지막 커밋 메시지 수정하기 커밋 히스토리 확인하기 (log의 다양한 옵션을 활용하자) 깃 커밋 메시지 작성법 Commit이란 무엇인가? 커밋이란 업데이트를 확정하는 순간의 스냅샷이다. 확정된 순간의 코드 상태를 커밋 메시지와 함께 저장소(레포지토리, 깃 디렉토리)에 저장(기록)한다. Commit = hash + message + author + code snapshot > 커밋 메

2021년 9월 25일
·
0개의 댓글
·