docs: 문서 최신화 (#189)

wibaek · web-flow · commit f3c85e2ee741 · 2025-07-15T10:16:54.000+09:00
* docs: onboarding.md 변경

* docs: git-cicd 추가

* docs: convention.md 수정
diff --git a/docs/convention.md b/docs/convention.md
@@ -1,19 +1,22 @@
 # solid-connect-web 컨벤션
+
 솔리드커넥션 웹 프로젝트의 컨벤션을 정리한 문서입니다.
 
 ## 이름 컨벤션
-- pages/ 에 정의하는 페이지 컴포넌트는 ~Page로 끝나야 합니다.
 
 ### 파일명
+
 - 파일명은 기본적으로 kebab-case로 작성합니다.
 - React Component 파일명은 PascalCase로 작성합니다.
-  - 현재 React Component 파일명을 kebab-case에서 PascalCase로 변경하는 작업을 진행 중입니다.
 
 ## CSS
+
 ### CSS 속성 선언 순서
+
 Tailwindcss의 속성은 린터에 의한 자동 정렬을 사용합니다.
 
 ### (Legacy)CSS 속성 선언 순서
+
 1. **display** - 표시(관련속성:visibility)
 2. **overflow** - 넘침
 3. **float** - 흐름(관련속성:clear)
@@ -24,4 +27,4 @@ Tailwindcss의 속성은 린터에 의한 자동 정렬을 사용합니다.
 8. **background(그룹)** - 배경
 9. **font(그룹)** - 폰트(관련속성:colr,letter-spacing,text-align,text-decoration,text-indent,vertical-align,white-space 등)
 10. **animation** - 동작(관련속성:animation,transform,transition,marquee 등)
-11. **기타** - 위에 언급되지 않은 나머지 속성들로 폰트의 관련 속성 이후에 선언하며, 기타 속성 내의 선언 순서는 무관함.
+11. **기타** - 위에 언급되지 않은 나머지 속성들로 폰트의 관련 속성 이후에 선언하며, 기타 속성 내의 선언 순서는 무관함.
diff --git a/docs/git-cicd.md b/docs/git-cicd.md
@@ -0,0 +1,44 @@
+# solid-connect-web Git, CI/CD 관련
+
+## Git 커밋 메시지 규칙
+
+Git 커밋 메시지는 다음과 같은 규칙을 따릅니다.
+
+```plain text
+<type>: <subject>
+<body>
+```
+
+### Type
+
+- feat : 새로운 기능 추가, 기존의 기능을 요구 사항에 맞추어 수정
+- fix : 기능에 대한 버그 수정
+- refactor : 기능의 변화가 아닌 코드 리팩터링 ex) 변수 이름 변경
+- style : 코드 스타일, 포맷팅에 대한 수정
+- test : 테스트 코드 추가/수정
+- docs : 문서(주석) 수정
+- chore : 패키지 매니저 수정, 그 외 기타 수정 ex) .gitignore
+
+### Subject
+
+Type 과 함께 헤더를 구성합니다.
+
+### Body
+
+헤더로 표현이 가능하다면 생략이 가능합니다. 아닌 경우에는 자세한 내용을 함께 적어 본문을 구성합니다.
+
+## 버저닝
+
+Line의 HeadVer을 사용하여 버저닝을 합니다.
+
+[HeadVer - 기민한 프로덕트 팀을 위한 새로운 버저닝 시스템](https://techblog.lycorp.co.jp/ko/headver-new-versioning-system-for-product-teams)
+
+빌드 버전은 빌드시 자동으로 증가합니다. 헤드 버전은 headver.json 파일에 정의되어 있으며, 배포 이후 수동으로 업데이트 해야합니다.
+
+## CI/CD
+
+GitHub Actions, Vercel를 사용하여 CI/CD를 관리합니다.
+
+main 브랜치에 push가 되면 자동으로 CI가 진행되어 stage 환경에 배포됩니다.
+
+Github Actions의 'Build and Vercel Production Deployment' 를 가동시키면 CD가 진행되어 production 환경에 배포됩니다.
diff --git a/docs/onboarding.md b/docs/onboarding.md
@@ -1,18 +1,21 @@
 # solid-connect-web 온보딩
+
 솔리드커넥션 웹 프로젝트에 새롭게 참가하는 개발자를 위한 온보딩 문서입니다.
 
-solid-connect-web은 Next.js(Pages Router) 기반의 프로젝트입니다.
+solid-connect-web은 Next.js(App Router) 기반의 프로젝트입니다.
 
 ## 개발 시작하기
+
 ```bash
 npm install
 npm run dev
 ```
 
 ## 린팅, 포매팅
+
 - ESLint
 - Prettier
-해당 프로젝트에서는 ESLint와 Prettier를 사용하여 코드의 품질을 관리합니다.
+  해당 프로젝트에서는 ESLint와 Prettier를 사용하여 코드의 품질을 관리합니다.
 
 ESLint는 eslint-config-airbnb를 기반으로 next의 기본적인 next관련 규칙을 추가해주는 @next/next/recommended를 추가해 사용하고 있습니다.
 
@@ -22,31 +25,36 @@ ESLint는 eslint-config-airbnb를 기반으로 next의 기본적인 next관련 
 - [Next.js ESLint Guide](https://nextjs.org/docs/pages/building-your-application/configuring/eslint)
 
 ### import 순서 정렬
+
 import 순서를 정렬하기 위해 Prettier 플러그인인 @trivago/prettier-plugin-sort-imports를 사용하고 있습니다.
 
 TODO: eslint-plugin-import의 import/order로 변경, 규칙 목록 작성
 
 ## 프로젝트 구조
+
 - public: 정적 파일
 - docs: 문서 파일
 - src
+  - /api: API call 인터페이스
+  - /apps: Next.js 지정 app 파일
   - /components: 공용 컴포넌트 파일
   - /constants: 상수 파일
   - /containers: 비공용 컴포넌트 파일
-  - /context:
+  - /context: React 컨텍스트 파일
   - /libs: 외부 라이브러리 사용 파일
-  - /pages: Next.js 지정 page 파일
-  - /services: API call 인터페이스
   - /styles: 정적 css 파일
   - /types: TypeScript 타입 정의 파일
   - /utils: 유틸성 함수
 - .env: 공개 환경 변수
 - .env.local: 미공개 환경 변수
 - .eslintrc.json: ESLint 설정
 - .prettierrc.json: Prettier 설정
-
+- headver.json: 버저닝중 head 버전 관리용 파일
+- tailwind.config.js: Tailwind CSS 설정
+- tsconfig.json: TypeScript 설정
 
 ## 인증 처리
+
 인증 처리를 공통으로 처리하기 위하여, 인증과 관련된 절차를 자동으로 처리해주는 axios client가 utils에 준비되어 있습니다.
 
-모든 인증이 필요한 API 요청은 기본적으로 server side rendering이 아닌, client side rendering 단계에서 진행하고 있습니다. 인증이 필요하지 않은 페이지는, 기본적으로 server side rendering과 static rendering을 사용하는 것을 권장합니다.
+모든 인증이 필요한 API 요청은 기본적으로 server side rendering이 아닌, client side rendering 단계에서 진행하고 있습니다. 인증이 필요하지 않은 페이지는, 기본적으로 server side rendering과 static rendering을 사용하는 것을 권장합니다.
