colio/README.md

Colio

⚠️ 참고

• 본 레포지토리는 중요 프로젝트 코드를 한 공간(nkey's gitea)에서 보여주기 위해 가져온 것이고, 실제 작업은 https://github.com/plers-org 의 비공개 레포지토리에서 진행합니다.
• 따라서 이슈와 중요 정보 등은 빠져있을 수 있습니다.

---

Flow

Developer Docs : Git Convention

commit tag convention

태그 첫글자는 대문자로 하기!!

✨ Feat: 새로운 기능을 추가 [:sparkles]

🐛 Fix: 버그 수정 [:bug]

🗃️ Comment: 필요한 주석 추가 및 변경 [:card_file_box]

➕ Dependency/Plugin: 의존성 설정(requirements.txt 등) [:heavy_plus_sign]

📝 Docs: 문서 수정 [:memo]

🔀 Merge: 브랜치 머지[🔀]

♻️ Refactor: 코드 리팩토링 [:recycle]

🔥 Remove: 파일을 삭제하는 작업만 수행한 경우 [:fire]

🔧 Settings: 환경변수, 세팅 변경 [:wrench]

Branch convention

main : 배포 가능한 브랜치. 항상 배포 가능한 상태 유지

dev : 배포에 적용하기 전 코드 테스트 브랜치

{커밋 컨벤션}/#{이슈번호} : 새로운 기능을 개발하는 브랜치

작업 flow

주차별 스프린트에서 기능단위로 서브이슈 생성

dev 브랜치 최신화

기능 개발 후 commit&push

팀장 코드 리뷰 후 본인이 머지

이슈 완료 조건 만족 시 이슈 close

예시 플로우

    ```
        # 새로운 기능 개발
        git switch dev
        git pull upstream dev
        git switch -c 브랜치명 (ex. Feat/#{issue-number})
        열심히 기능 개발~!

        # 작업 완료 후
        git add .
        gitmoji -c
        choose a gitmoji -> {이모지}
        enter the commit title -> {커밋 태그}: [#이슈번호] {작업 내용}
        git push origin 브랜치명
        {커밋 태그}/{#이슈번호} → dev 로 Pull Request 생성
        코드 리뷰 후 피드백 적용
        본인이 PR 머지
        git branch -d 브랜치명
        git push origin --delete 브랜치명
    ```

Download Gitmoji

1. check version

node -v

npm -v

2. download gitmoji cli and check version

npm install -g gitmoji-cli

gitmoji -v

3. initiate gitmoji

gitmoji -i

gitmoji list

gitmoji -l

update gitmoji version

npm update -g gitmoji-cli