Code Convention

Code Convention

---

1.망명 규칙

🖤 코드 컨벤션

⚠️ 명명 규칙 //phill

• 변수명, 함수명 : 카멜 케이스를 사용한다.
• 생성자 함수, 클래스 : 파스칼 케이스를 사용한다.
• 그 외(ex. 상수) : 스네이크 케이스를 사용한다. //phill
• 배열 : 복수형으로 이름을 생성한다.

---

2.블록 규칙

• 한 줄 짜리 블록일 경우라도 { }를 생략하지 않고 명확히 줄 바꿈 하여 사용한다.

---

3.문장 종료

• 문장 종료 시에는 반드시 세미콜론(;)을 사용한다.

---

4.함수

• 배열 : 복수형으로 이름을 생성한다.

블록 구문

• 한 줄 짜리 블록일 경우라도 { }를 생략하지 않고 명확히 줄 바꿈 하여 사용한다.

🔚 문장 종료

• 문장 종료 시에는 반드시 세미콜론(;)을 사용한다.

↪️ 함수 //phill

• return : 바로 return 하는 경우에도 return을 사용한다.
• 불린 반환 함수 : 반환 값이 불린인 함수는 ‘is’로 시작한다. //phill

---

5.이벤트 핸들러

• 이벤트 핸들러는 ‘on’으로 시작한다.

---

6.주석

• 작성자, 작성한 내용을 함께 작성한다. ======= 이벤트 핸들러

• 이벤트 핸들러는 ‘on’으로 시작한다.

↪️ 주석

• 작성자, 날짜, 작성한 내용을 함께 작성한다.

🖤 커밋 메시지 컨벤션

✅

1. 커밋 유형 지정

• 커밋 유형 소문자로 시작하기

  커밋 유형	의미
  feat	새로운 기능 추가
  fix	버그 수정
  chore	패키지 매니저 수정, 그 외 기타 수정 ex) .gitignore
  docs	문서 수정
  style	코드 formatting, 세미콜론 누락, 코드 자체의 변경이 없는 경우
  refactor	코드 리팩토링
  design	CSS 등 사용자 UI 디자인 변경
  test	테스트 코드, 리팩토링 테스트 코드 추가
  ci	CI관련 설정 수정
  build	빌드 관련 파일 수정
  comment	필요한 주석 추가 및 변경
  rename	파일 또는 폴더 명을 수정하거나 옮기는 작업만인 경우
  remove	파일을 삭제하는 작업만 수행한 경우
  !BREAKING CHANGE	커다란 API 변경의 경우
  !HOTFIX	급하게 치명적인 버그를 고쳐야 하는 경우

2. 제목은 뒤 본문은 빈행으로 분리

• 커밋 유형 이후 본문은 한글로 작성하여 내용이 잘 전달될 수 있도록 할 것
• 본문에는 변경한 내용과 이유 설명 (어떻게보다는 무엇 & 왜를 설명)

feat: 새로운 기능에 대한 커밋
fix: 버그 수정에 대한 커밋
chore: 그 외 자잘한 수정에 대한 커밋
docs: 문서 수정에 대한 커밋
style: 코드 스타일 혹은 포맷 등에 관한 커밋
refactor: 코드 리팩토링에 대한 커밋
test: 테스트 코드 수정에 대한 커밋
ci: CI관련 설정 수정에 대한 커밋
build: 빌드 관련 파일 수정에 대한 커밋

3. 제목 첫 글자는 소문자로, 끝에는 . 금지

4. 제목은 한글 기준으로 20~30자 이내

5. 자신의 코드가 직관적으로 바로 파악할 수 있다고 생각하지 말자

6. 여러가지 항목이 있다면 글머리 기호를 통해 가독성 높이기

- 변경 내용 1
- 변경 내용 2
- 변경 내용 3

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

• 팀원과의 소통
• 편리하게 과거 추적 가능
• 나중에 실무에서 익숙해지기 위해

🖤 한 커밋에는 한 가지 문제만!

• 추적 가능하게 유지해주기
• 너무 많은 문제를 한 커밋에 담으면 추적하기 어렵다.

🖤 CLI에서 커밋 메시지 여러 줄로 작성하는 방법

✅ 쌍따옴표를 닫지 말고 개행하며 작성 → 다 작성한 후에 쌍따옴표를 닫으면 작성 완료

git commit -m "FEAT: 회원가입 기능 추가

- 회원가입 기능 추가"

//여기까지가 진욱님 내용입니다.

프로젝트명 : Git Confilct Test

프로젝트 개요 및 설명

• README.md 파일 작성을 통해 conflict 유도하기
• 해당 레퍼지토리는 conflict를 유도하여 해결하는 연습을 진행한다.

배포 링크 및 시연 영상 : URL

팀원 소개

• 조장 : 영록
• 조원 : 선아
• 조원 : 지영
• 조원 : 진욱
• 조원 : 필우

사용 기술 스택

• HTML
• JS

---

Code Convention

1. 명명 규칙

• 변수명, 함수명 : 카멜 케이스를 사용한다.

• 생성자 함수, 클래스 : 파스칼 케이스를 사용한다.

• 그 외(ex. 상수) : 스네이크 케이스를 사용한다.

• 배열 : 복수형으로 이름을 생성한다.

2. 블록 구문

• 한 줄 짜리 블록일 경우라도 { }를 생략하지 않고 명확히 줄 바꿈 하여 사용한다.

3. 문장 종료

• 문장 종료 시에는 반드시 세미콜론(;)을 사용한다.

4. 함수

• return : 바로 return 하는 경우에도 return을 사용한다.
• 불린 반환 함수 : 반환 값이 불린인 함수는 ‘is’로 시작한다.

5. 이벤트 핸들러

• 이벤트 핸들러는 ‘on’으로 시작한다.

6. 주석

• 작성자, 작성한 내용을 함께 작성한다.

---

Git Commit Convention

• TYPE : 어떤 의도로 커밋했는지 명시한다.

  • feat : 새로운 기능 추가
  • fix : 버그 수정
  • docs : 문서 수정 (ex. README.md 수정 등)
  • style : 코드 포맷 변경, 세미콜론 누락 등 코드 수정이 없는 경우 (ex. 오타 수정, 탭 사이즈 변경, 변수명 변경 등)
  • test : 테스트 추가, 테스트 리팩토링 (프로덕션 코드 수정 X)
  • chore : 빌드 테스크 업데이트, 패키지 매니저를 설정하는 경우 등 (프로덕션 코드 수정 X) (ex. package.json의 변경이나 dotenv의 요소 변경 등, 모듈의 변경)
  • Design : CSS 등 사용자 UI 디자인 변경
  • !BREAKING CHANGE : API 변경의 경우 (ex. API의 arguments, return 값의 변경, DB 테이블 변경, 급하게 치명적인 버그를 수정할 경우)
  • !HOTFIX : 긴급하게 치명적인 버그를 고쳐야 하는 경우
  • Comment : 필요한 주석 추가 및 변경
  • Rename : 파일 혹은 폴더명을 수정하거나 옮기는 작업인 경우
  • Remove : 파일을 삭제하는 작업만 수행한 경우

• SUBJECT

  • 제목은 최대 50글자가 넘지 않도록 하고, 마침표 및 특수기호는 사용하지 않는다.
  • 영문으로 표기하는 경우 동사 원형을 가장 앞에 두고, 첫 글자는 대문자로 표기한다. (과거시제 X)
  • 제목은 서술형 문장이 아닌 간결하고 요점적인 서술을 한다. (ex. Fixed → Fix | Added → Add | Modified → Modify)
  • 한글로 제목을 작성할 경우 ⇒ 고침, 추가, 변경 으로 시작

• BODY : 상세 설명 작성

  • 한 줄 당 72자 내로 작성한다.
  • 양에 구애받지 않고 최대한 상세히 작성한다.
  • 어떻게 변경했는지보다 무엇을 변경했는지 또는 왜 변경했는지를 설명한다.

• FOOTER : 선택적이며, 이슈 트래커 ID 작성

  • "유형: #이슈 번호" 형식으로 사용
  • 여러 개의 이슈 번호를 적을 때는 쉼표(,)로 구분
  • 이슈 트래커 유형은 다음 중 하나를 사용한다.
    • Fixed : 이슈 수정 중 (아직 해결되지 않은 경우)
    • Resolves : 이슈를 해결했을 때 사용
    • Ref : 참고할 이슈가 있을 때 사용
    • Related to : 해당 커밋에 관련된 이슈 번호 (아직 해결되지 않은 경우) // 여기까지가 지영님 내용입니다.

프론트엔드 2조 convention 20231003

Index

1. Javascript Code Convetion
2. Git Commit Convention

Javascript Code Convention

1. 명명 규칙

   • 변수명, 함수명 카멜 케이스를 사용한다.

         var firstName;

   • 생성자 함수, 클래스 파스칼 케이스를 사용한다.

         var FirstName;

   • 그 외 (ex.상수) 스네이크 케이스를 사용한다.

         var first_name;

   • 배열 복수형 이름을 생성한다.

         var arrays;

2. 블록 구문

   • 한 줄 짜리 블록일 경우라도 {}를 생략하지 않고 명확히 줄 바꿈하여 사용한다.

3. 문장 종료

   • 문장 종료 시에는 반드시 세미콜론(;)을 사용한다.

         // x
         function semicolon(){
             return x
         }
         // o
         function semicolon(){
             return x;
         }

4. 함수

   • return 바로 return하는 경우에도 return을 사용한다.

         // X
         var return = (func)=> {func+1;};
         // o
         var return = (func)=>{return func+1};

   • boolean 반환 함수 반환 값이 불린인 함수는 'is'시작 한다.

         function isBoolean() {
             
         }   

5. 이벤트 핸들러

   • 이벤트 핸들러는 'on'으로 시작한다.

6. 주석

   • 작성자, 날짜 및 작성한 내용을 함께 작성한다.

         // 홍길동, 20231001 코드를 수정하였습니다.

Git Commit Convention