팀 프로젝트를 원활히 시작하고 협업 효율을 높이기 위해, 아래 항목들을 팀원들과 함께 논의한 후 구체적으로 작성해 주세요. 이 템플릿은 예시이며, 필요한 사항들을 추가해서 작성하시면 더욱 좋습니다.
| 팀원 | 주요 담당 |
|---|---|
| 박다슬 | 답글 API 개발, 테스트 코드 작성 |
| 오연진 | 큐레이팅 API 개발, 스키마 정의 및 구현 |
| 김동현 | 스타일 API 개발, 유효성 검증 코드 작성 |
| 항목 | 기간 | 내용 |
|---|---|---|
| 계획서 작성 및 역할 분배 | 2025.08.11 ~ 2025.08.12 | |
| 1차 점검 | 2025.08.14 (목) 10시 | 1차 팀 전체 코드 점검, 추가 구현 사항 논의 |
| 프로젝트 중간 발표 | 2025.08.20 (수) 13시 | 진행 상황, 목표 대비 진척도, 현재 진행중인 문제와 해결 과정, 현재까지의 결과물 시연 |
| 2차 점검 | 2025.08.22 (금) 10시 | 2차 팀 전체 코드 점검, 추가 구현 사항 논의 |
| 프로젝트 최종 발표 | 2025.08.29 (금) 10시 | 프로젝트 개요, 팀 구성 및 역할, 협업 방식 소개, 프로젝트 수행 절차 및 방법 소개, 결과, 셀프 피드백 |
| 분류 | 사용 예정 도구 |
|---|---|
| Backend | Node.js (Express) |
| Database | PostgreSQL |
| API 문서화 | Swagger |
| 협업 도구 | Discord, GitHub, Notion |
| 일정 관리 | GitHub Issues + Notion 타임라인 |
| 유효성 검증 | zod |
| 테스트 도구 | Postman |
| 배포 | Render, vercel |
| 항목 | 내용 | 작성 방법 |
|---|---|---|
| 네이밍 컨벤션 | camelCase (변수, 함수), PascalCase (클래스, 파일), scream snake case(상수, 환경 변수) | |
| 커밋 컨벤션 | feat, fix, refactor, docs, style, test, chore 등 |
작성 예시) Feat: "회원 가입 기능 구현"
SMS, 이메일 중복확인 API 개발
Related to: #48, #45 | git add . git commit ( vim에서 작성 )
로그인 기능을 구현했습니다. 본문은 길게 써도 됩니다. 이메일 유효성 검사 로직 추가~~
Related to: #48, #45 ( #번호는 오류번호 ) |
| 브랜치 전략 | main, feature/기능명, bugfix/이슈번호, develop/기능명 | 작성 예시)
Merge 후 원격 브랜치 삭제는 다음과 같이 된다고 합니다.
로컬 브랜치 삭제
git switch main git branch -d 삭제할 브랜치 이름
원격 브랜치 삭제
git push origin --delete 삭제할 브랜치 이름
원격 브랜치 목록 정리
→ 원격, 로컬 브랜치 상태 동기화
→ 원격 저장소에서 최신 정보 가져오고, 삭제된 브랜치 정리
git fetch --prune |
| Prettier 규칙 | {
"singleQuote": true,
"semi": true,
"tabWidth": 2,
"useTabs": false,
"printWidth": 80,
"trailingComma": "all"
} | * 적용하지 않은 형태가 자연스러운 부분엔
// prettier-ignore
주석 달면 됩니다! |
| 개발 폴더 구조 | 개발 폴더 구조 | |
| 깃허브 이슈 컨벤션 | 라벨
→ todo, todo-details, 버그, 개발, 수정, 테스트, 추가구 | todo 작성 방법
→ Title 은 [이름 | 오늘날짜] 하루간 할 내용 요약 형식으로 작성해 주세요 (날짜는 MMDD 형식으로 작성해 주세요)
ex) [지인호 | 0910] 로그인 및 회원가입 로직 개발
내용은 다음과 같이 작성해주세요 `- [ ] 오늘 할 내용 - 001
프로젝트 준비 과정 또는 멘토링을 통해 발견된 잠재적 이슈들을 정리해 주세요.