코딩 컨벤션

🐶 커밋 컨벤션

commit convention

[Type] 커밋 메시지

[Feat] Commit Message
[Feat] 메인 화면 구현

Type의 내용은 첫 글자만 대문자. 뒤에는 소문자로 작성

Type

Type	설명	예시
Fix	버그, 오류 해결	ex) [Fix] callback error
Add	Feat 이외의 부수적인 코드 추가/ 라이브러리 추가/ 새로운 View나 Activity 생성	ex) [Add] LoginActivity
Feat	새로운 기능 구현	ex) [Feat] google login
Del	쓸모없는 코드 삭제	ex) [Del] unnecessary import package
Remove	파일 삭제	ex) [Remove] 중복 파일 삭제
Refactor	내부 로직은 변경 하지 않고 기존의 코드 개선하는 리팩토링 시, 세미콜론 줄바꿈 포함	ex) [Refactor] MVP architecture to MVVM
Chore	그 이외의 잡일/ 버전 코드 수정, 패키지 구조 변경, 파일 이동, 가독성이나 변수명, reformat 등	ex) [Chore] delete unnecessary import package
Design	just 화면	ex) [Design] iphone 12 레이아웃 조정
Comment	필요한 주석 추가 및 변경	ex) [Comment] 메인 뷰컨 주석 추가
Docs	README나 wiki 등 내용 추가 및 변경	ex) [Docs] README 내용 추가
Test	테스트 코드 추가	ex) [Test] 로그인 토큰 테스트 코드 추가

🐶 주석 및 로그 (Comments & Logs)

주석 : 무엇을 왜 하는지 적기
- 복잡한 로직이나 예외 처리에 주석 필수!
TODO: [이름] 나중에 해야 할 일
- // TODO: [이름] 내용 형식으로 적기
console.log : 개발 중에는 쓰고, 커밋(Commit) 할때는 반드시 삭제하기
- console.log(error)만 허용

🐶 백/서버 연동 방식

async/await + fetch or axios⭐

⭕ 장점 : 코드 가독성이 제일 좋음, 응답에 대한 처리를 바로 하지 않아도 됨

❌ 단점 : 함수의 선언부를 따로 수정해야 함 (async, await 같은 거)

// 프론트 개발 파일에서

const signup = async () => {
    const res = await api.signup(signupForm)
    // console.log('Signup.vue에서 res 변수 : ', res)
}

// index.js (api)

const signup = async (req) => {
    const res = await api.post('/user/join', req)
    // console.log(res)
    return res
}

document.getElementById("await").addEventListener("click", async () => {
    let response = await axios.get("<http://10.10.10.20:8080/test.json>")
    // console.log(response.key01);
}