Skip to content
위영민 edited this page Nov 9, 2022 · 2 revisions

image

원티드 프론트 프리온보딩 7차 12 TEAM - Assignment 5 WIKI 👋🏻

Assignment 5 주제 : 검색어 자동완성 기능을 포함한 검색창 구현(with. 동료학습)



우리가 생각한 과제진행 방식

프로젝트 관리 방법 & 브랜치 컨벤션 설정

Base by. Git Flow

main(root) // 최종 제출 브랜치
  -> develop  // 초기 설정만 완료된 dev 브랜치 -> 각 staged 마다 정제된 best practice 코드가 누적되는 브랜치
    -> 다영(영어로) // 초기 설정만 적용된 dev 브랜치로부터 생성한 "다영" 님 root 브랜치 (해당 브랜치에서 자유롭게 브랜치를 더 생성해도 상관 없음 !)
    -> 영민 // (이하 동일)
    -> 종현 // (이하 동일)
    -> ...
  • PR(Pull Request) 등록 시, 타겟 브렌치가 main or develop 브랜치가 아닌 지 확인 권고 !
    • main 이나 develop 은 팀원들의 동의가 이뤄진 커밋만 머지되도록 합니다.
    • 그 외 본인 브랜치(본인의 root 브랜치) <- 본인 브랜치로부터 파생된 하위 브랜치로 PR을 올리는 경우는 자유롭게 진행해도 무방합니다.
  • 해당 방식을 설정한 이유
    브랜치에서 타입스크립트로 각자 작업하고 이 브랜치들을 모아 best practice를 토론을 통해 정하기로 했습니다. live share 를 통해 develop 브랜치의 코드를 함께 보고 개선한 결과를 main 브랜치로 통합, 배포하는 방식으로 진행했습니다. 독립적인 개발 환경을 갖추면서도 추적이 쉽고, 협업에 유용한 git flow 방식을 선택했습니다.

커밋 메시지 컨벤션 설정

Base by. Gitmoji

// 자주 사용 예정 깃모지 모음= :sparkles: // 새로운 기능이 추가되었을 때
💄 = :lipstick: // UI, 스타일링 관련 작업일 때
🌱 = :seedling: // API, HTTP Client 관련 시드 작업일 때
🔨 = :hammer: // 코드를 리팩토링 할 때
🎨 = :art: // 코드의 형식 / 구조를 개선 할 때
🐛 = :bug: // 버그를 발견했을 때
🚑 = :ambulance: // 버그를 고칠 때
📝 = :memo: // 사소한 코드 또는 언어를 변경할 때
🔥 = :fire: // 코드 또는 파일 제거할 때
🍱 = :bento: // 유틸함수, 타입, 상수, 정적 리소스들을 추가할 때= :heavy_plus_sign: // 의존성 패키지 추가했을 때= :heavy_minus_sign: // 의존성 패키지 제거했을 때
🐎 = :racehorse: // 성능을 향상시킬 때
♿️ = :wheelchair: // 접근성을 향상시킬 때
📚 = :books: // 문서를 쓸 때= :white_check_mark: // 테스트 관련 작업했을 때
🚀 = :rocket: // 배포, 개발 작업 과 관련된 모든 것
💚 = :green_heart: // CI 빌드를 고칠 때
🎉 = :tada: // 프로젝트 시작 & 초기화

/**
 * With References
 * + https://overcome-the-limits.tistory.com/6
 * + https://www.webfx.com/tools/emoji-cheat-sheet/
 */
  • 상황에 맞춰서 정해진 범위내에서 사용

  • 메시지는 한글 (기업전형 진행시, 해당 기업 컨셉에 언어는 변경)

  • 사용 이유

    • 범용적으로 사용되는 Keyword(feat, fix, chore ...) Based 커밋 메시지 컨벤션도 여러명이 협업하는 상황에 좋은 컨벤션이라 생각했습니다.
    • 깃모지는 아직도 "범용적" 이라고 표현할 순 없지만, 어느 정도 공식 문서상에서 일반화한 각 이모지마다 사용 용도가 정해져 있고, 그것이 텍스트 키워드 메시지로 보았을 때보다 좀 더 직관적인 장점이 있다고 생각했습니다. 더불어 이번 과제에 참여하는 팀원들 대부분이 사용한 경험이 없었기 때문에 새로운 것을 적응해보는 취지하에 이 방식을 채택했습니다.