TOPPINGS

🚀 back story, vision
🕹 team
📚 스토리북 바로가기

🗂 사용 기술 스택

• package manage
  • yarn berry (P'n'P)
  • Turborepo
• deploy
  • Github action
  • Vercel
• client
  • SSR: NextJS (v13)
  • styling: emotion
  • Typescript
  • state-management client: Recoil server: react-query (v4)
• admin
  • SSR: NextJS (v13)
  • styling: emotion
  • Typescript
  • state-management client: Recoil server: react-query (v4)

👨‍⚖️ Conventions

🪵 Branch

* feat-*
|
| * feat-*
|/
* main

✍️ Commit

feat : 기능 추가
chore : gradle 수정, package.json 같이 프로젝트 환경에 있어서의 변경점
fix : 버그 픽스
hotfix : 긴급한 버그 픽스
docs : 문서 관련 변경점

Commit 형식은 다음으로 맞춰주세요.

[Commit 종류](workspace): [Commit 내용]
Ex: feat(client): 음식점 상세조회 기능을 구현함
Ex: fix(admin): 음식점 관리 목록을 조회할 수 있도록 함.

⛔️ 커밋을 세분화하는 것을 습관화 합시다.

---

Branch 단위

• main : 최종 단위 브랜치.
• feat: 기능 추가 및 구현을 위한 브랜치. main 브랜치로부터 분기되는 브랜치입니다.
• chore: 문서작업, configuration작업
• hotfix: 배포한 버전에 긴급한 수정을 진행해야 하는 경우, main 브랜치에서 분기하는 브랜치입니다. 문제가 되는 부분의 수정이 완료되면, main 브랜치에 다시 병합하여 배포를 진행해주세요.

Branch 형식은 다음으로 맞춰주세요.

[Branch 종류]-[Branch 이름] ex: feat-main, hotfix-0314-QA

📝 Code Convention

1. 함수 네이밍과 변수명은 camelCase(카멜케이스)를 원칙으로 합니다.
2. 코드가 200줄이 넘어가면 리팩토링을 고민해봅니다.
3. 필요하다고 생각되는 곳에는 주석을 꼭 작성합니다.

🌟 Contributors