TWC-Backend-Node

프로젝트 기간: 2024.12.30 ~ 2025.02.15

• 뉴스 인기 키워드로 구성된 워드클라우드
• 키워드 별로 여러 언론사 뉴스 모아보기
• 원하는 뉴스 기사 스크랩 및 타임라인 제작

TWC_BE_Python Github Repository

🏗️ Architecture

🔧 Tech Stack

🧑‍💻 Developers

김형석	진소은	홍유진
로그인 스크랩	JWT 인증 뉴스/키워드	회원가입 타임라인

📜 Git Convention

Branch

브랜치	설명
main	제품으로 출시 (배포)
develop	배포 전 작업 기준
feature	기능 단위 개발 및 수정
hotfix	긴급 수정

Branch Details

• main
  • 실제 서비스가 이루어지는 브랜치입니다.
  • 배포 중 긴급하게 수정할 건이 생길 시, hotfix 브랜치를 만들어 수정합니다.
• develop
  • 개발, 테스트, 릴리즈 등 배포 전 작업의 기준이 되는 브랜치입니다.
  • main 브랜치에서 분기합니다.
  • 해당 브랜치를 default로 설정하고, 평소에는 이 브랜치를 기반으로 개발을 진행합니다.
  • 모든 기능이 추가되고 버그가 수정되어 배포 가능한 안정적인 상태라면 main 브랜치에 병합합니다.
• feature
  • 새로운 기능 개발 및 버그 수정이 필요할 때마다 develop 브랜치에서 분기하여 각 개발자가 맡은 작업을 개발하는 브랜치입니다.
  • 작업이 완료되면 develop 브랜치에 병합합니다.
• hotfix
  • 배포한 버전에 긴급하게 수정을 해야할 필요가 있을 때 main 브랜치에서 분기하는 브랜치입니다.
  • main 브랜치에서 바로 작업을 시작하여, 수정이 끝나면 main 브랜치에 병합하여 배포하고, develop 브랜치에도 병합하여 수정 사항을 반영합니다.

Branch Naming

1. main, develop
   본래 이름 그대로 사용

2. feature
   feat/{#issue-number}-{feature-name}
   ex) feat/#2-build-gradle-script

3. hotfix
   hotfix/내용
   ex) hotfix/timeline-create-error

Commit Type

타입	설명
feat	새로운 기능 추가
fix	버그 수정
test	테스트 코드 추가, 수정
refactor	기존 코드의 리팩토링 (기능 변화 없음)
chore	코드 외 작업 (예: 설정 변경, 라이브러리 설치/삭제)
build	빌드 관련 작업 (예: 빌드 설정 수정, 종속성 설치/삭제)
docs	문서 추가, 수정 (예: README 업데이트)
ci	CI 설정 파일 추가, 수정
perf	성능 개선
style	코드 포맷팅, 스타일 변경 (기능에 영향 없음)
comment	코드에 필요한 주석 추가, 수정
hotfix	긴급한 치명적인 버그 수정

Commit Message

// Header, Body는 빈 행으로 구분한다.

타입: 제목 (#이슈번호)     // Header(헤더)

본문      // Body(바디)

ex)

fix: Safari에서 모달을 띄웠을 때 스크롤 이슈 수정 (#123)

모바일 사파리에서 Carousel 모달을 띄웠을 때,
모달 밖의 상하 스크롤이 움직이는 이슈 수정.

Commit Message Rules

1. 제목과 본문을 빈 행으로 구분한다.
2. 제목은 50글자 이내로 제한한다.
3. 제목의 첫 글자는 대문자로 작성한다.
4. 제목 끝에는 마침표를 넣지 않는다.
5. 제목은 명령문으로 사용하며 과거형을 사용하지 않는다.
6. 본문은 72자마다 끊어 줄을 바꿔준다.
7. 어떻게 보다는 무엇과 왜를 설명한다.
8. 검토자가 원래 문제가 무엇인지 이해한다고 가정하지 말고 확실하게 설명을 추가한다.
9. 자신의 코드가 직관적으로 바로 파악 할 수 있다고 생각하지 말자.
10. 팀에서 정한 Commit 규칙을 따르자.

Issue Template

[type] 제목

### 작업 브랜치
`브랜치 이름`

## 📢 설명
> 요약
- 상세 내용1
- 상세 내용2

## ✅ 작업 내용
- [x] 내용1
- [ ] 내용2

## 📍 참고 자료
- 자료1
- 자료2

PR Template

Type: 제목

## #️⃣ 연관된 이슈

> #이슈번호

## 📝 작업 내용

> 이번 PR에서 작업한 내용을 간략히 설명해주세요(이미지 첨부 가능)

## 💬 리뷰 요구사항(선택)

> 리뷰어가 특별히 봐주었으면 하는 부분이 있다면 작성해주세요
>
> ex) 메서드 XXX의 이름을 더 잘 짓고 싶은데 혹시 좋은 명칭이 있을까요?

Git 협업 참고 자료

https://velog.io/@pgmjun/Github-%ED%98%91%EC%97%85-%EC%9D%B4%EA%B2%83%EB%A7%8C%EC%9D%80-%EC%95%8C%EC%9E%90-Issue-PR