팀 프로젝트 시작 전 준비 사항 - Conventions
컨벤션에 관해서 다음 내용들을 협의해야 한다.
- commit 규칙
- PR 규칙 및 템플릿 작성
- Issue 규칙 및 템플릿 작성
- Branch 생성 규칙
Git - 커밋 메시지 컨벤션
Git - Commit Message Convention 커밋 메시지를 작성할 때는 원칙을 정하고 일관성 있게 작성해야 한다. 아래는 유다시티의 커밋 메시지 스타일 가이드를 참조한 내용이다. 1. Commit Message Structure 기본적
doublesprogramming.tistory.com
Google Java Style Guide
1 Introduction This document serves as the complete definition of Google's coding standards for source code in the Java™ Programming Language. A Java source file is described as being in Google Style if and only if it adheres to the rules herein. Like ot
google.github.io
협업하며 맞춰본 자그마한 컨벤션 모음 zip
코드를 구현하다 보면 정말 말도안되게 작은 일인데 정하지 않고 넘어가면 피곤한 눈엣가시같은 규칙들이 있다.. 프로젝트의 규모는 점점 커지는데.. 이런 것들을 눈감고 지나가니.. 눈덩이처럼
rrecoder.tistory.com
팀 프로젝트 경험 및 문제 해결
깃 활용 어려움컨벤션 맞추기 어려움flex, position 사용으로 레이아웃이 달라져 디자인이 덮어지는 경우가 있음
velog.io
코딩 컨벤션의 장점
- 정해진 규칙이 있기 때문에 명칭이나 구조를 빠르고 정확하게 파악할 수 있다.
- 통일된 규약이 있으므로 모든 사람들이 코드를 이해하기 쉽다.
- 불필요한 유지보수가 줄어든다, 가독성이 좋아진다
코드에서 뿐만 아니라 Github에서 Issue나 PR작성할 때, 로컬에서 branch나 commit 메세지를 작성할때도 적용된다.
참고