New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

🛠 Naming Convention #2

Closed

doh3e opened this issue Dec 17, 2024 · 0 comments

Owner

doh3e commented Dec 17, 2024

1. 변수, 함수, 클래스, 디렉토리 등

환경	사용처	네이밍 룰	예시
Spring Boot	클래스, java파일	PascalCase	`UserServiceImpl`
	메서드, 변수	camelCase	`getUserInfo`
	상수	UPPER_CASE	`MAX_RETRIES`
Java	클래스	PascalCase	`OrderProcessor`
	메서드, 변수	camelCase	`calculateTotalPrice`
	상수	UPPER_CASE	`DEFAULT_TIMEOUT`
JavaScript	함수, 변수	camelCase	`fetchData`
	상수	UPPER_CASE	`API_ENDPOINT`
Vue.js	컴포넌트 파일	PascalCase	`UserProfile.vue`
	메서드, 변수	camelCase	`handleClick`
CSS	클래스명, ID	kebab-case	`.main-container`
	변수 (CSS 변수)	kebab-case	`--primary-color`

Boolean 타입 변수

접두사 is 사용
ex) is_exist

클래스

명사절 사용
테스트 클래스는 "Test"로 끝날 것. ex) WatcherTest

메서드

동사/전치사로 시작할 것
ex) renderHTML(), toString()

기타

임시 변수 외에는 반드시 1글자 이상으로 작성할 것
협업 시 알아볼 수 있게 이름 작성 (asdf 이런거 하지 마세요)
필요 시 주석으로 설명

2. 브랜치

master 브랜치

제품 출시 수준의 브랜치 / 배포 가능한 상태
배포 이력 관리 용
손 대지 마세요!

develop 브랜치

다음 서비스 개발 브랜치
개발 브랜치 병합 용
개발 완료 후 master로 병합
새로운 기능 생성 시 develop에서 분기하여 feature 브랜치 생성할 것
팀장 외 develop 브랜치를 직접적으로 건드리지 마세요!

feature 브랜치

새로운 기능 개발, 기능 관련 버그 수정 용 (이슈 번호 연동)
develop 브랜치로부터 분기하여 생성
front와 back 구분하여 생성
기능 개발 후 develop 브랜치로 Pull Request(PR)하기
기능 개발이 미완성 상태더라도 타 기능에서 필요시 중간 PR 가능
ex) 백엔드에서 로그인 기능을 만들려는 경우

git checkout -b feature/back/login develop

The text was updated successfully, but these errors were encountered:

doh3e pinned this issue

doh3e closed this as completed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment