오늘의 TIL

강인구·2025년 7월 21일

오늘은 프로그램에 직접적으로 관련된 학습보다는 협업과 발표에 관한 학습을 진행하였다.
첫번째는 대표적인 협업 프로그램인 GIT을 사용함에 있어 지켜야 하는 규칙과 사용 방법이다.

GIT 컨벤션 규칙

GIT 커밋 컨벤션은 협업 시 커밋 메시지를 일관성 있게 작성하기 위한 규칙이다.
메시지를 체계적으로 작성하면 변경 사항을 추적하기 쉽고, 코드 리뷰나 유지보수에도 큰 도움이 되기 때문에 컨벤션 규칙에 따라 커밋해야 한다.

기본 구조

커밋 메시지는 보통 type, body, footer 의 세 부분으로 나뉜다.
Type : 커밋의 목적을 나타내는 태그다. 대표적인 예시로는
feat(새로운 기능 추가),
fix(버그 수정),
docs(문서 수정),
style(코드 포맷 변경, 기능에는 딱히 변화가 없음),
refector(코드 리펙토링)
test : 테스트 코드 추가 또는 수정
chore : 빌드 설정, 패키지 변경 등의 잡일
remvoe : 파일 삭제
comment 주석 추가 또는 수정

Subject(제목)

제목은 50자 이내로 간결하게 작성.
명령형 동사를 사용한다.
마침표나 특수기호는 사용하지 말것.

Body(본문)

변경한 이유와 내용을 자세히 설명 - 다음 협업자가 보았을때 이어서 작업할수 있게, 혼자 사용하더라도 자신이 어디까지 진행했는지 확인하기 위함

한줄에 72자 이내로 작성
"어떻게"보다 "왜" 와 "무엇을" 중심으로 작성

Footer(꼬리말)

관련된 이슈 번호를 명시한다.
이유는 내가 진행한 이슈가 어떤건지 명확하게 작성하는 것이 주요 이유.

이슈 작성 규칙
제목 작성 규칙
1. 타입 키워드를 앞에 붙인다.
2. 핵심 내용을 간결하게 요약한다.(50자 이내로)

본문 작성 규칙
문제 설명 : 어떤 문제가 발생했는지>
재현 방법 : 어떻게 하면 문제를 재현할 수 있는지 단계별로
기대 결과 : 원래 기대했던 동작
스크린샷/로그 : 가능하면 첨부할것
환경 정보 : 브라우저, OS, 버전 등.

레이블 및 담당자
필요할시 담당자 지정 마일스톤연결

필요시 담당자를 지정하거나 마링스톤에 연결할것

PPT 작성 요령

프로젝트 발표회의 경우

클래스 다이어그램과, 플로우 차트등 이미지 자료르 적극적으로 사용할것.
텍스트가 많이면 청자들은 굉장히 피로감을 느끼며 혼란스러워 함.
그리고 이미지를 넣을때, 특히 클래스 다이어그램과 플로우차트는, 내부의 글자 사이즈를 키우고, 한페이지에 이미지 두개를 넣어서 첨부했을때 내부의 글이 안보인다면 장마다 이미지 한장씩 넣는것도 추천함.
장수가 늘어나는것보단 가독성을 높일것.
그리고 시연 영상이 있다면 PPT의 마지막이 아닌 초반에 삽입하라.
즉, 처음에 시연 영상을 넣어서 청자의 관심을 유도하는 거라고 볼 수 있다.
개발한 프로그램을 시연하는, 프로젝트 발표회에서는 청자의 몰입도를 높이기 위한 장치로 시연영상을 사용하는데, 이러한 시연 영상이 PPT 후미에 있으면 청자들은 금세 흥미가 떨어져서 발표에 집중을 하지 못한다.
그러면 전달하려고 하는 내용의 절반도 전달을 못하게 되니, 시연영상은 초반에 삽입할것.

profile
기획, 개발 지망

0개의 댓글