Skip to content

team-dbre/dbre_BE

Repository files navigation

📖 desub

design + subscription
쉽고 빠른 디자인 커뮤니케이션을 위한 디자인 월 구독 서비스


🔗 배포 링크


🗣️ 프로젝트 발표 영상 & 발표 문서

🗓️ 2024.00-.00 - 2024.00.00


🧰 사용 스택

🔧 System Architecture


👥 팀 동료

FE


@yoonhyeonjeong


@Ju-MINJAE


@hanhyochan


@jiseon-nnn

윤현정 주민재 한효찬 안지선

BE


@mountain-kangkang


@limsu1015

강산 임수혁

📑 프로젝트 규칙

Branch Strategy

  • main / dev 브랜치 기본 생성
  • main으로 직접 push 제한
  • PR 전 최소 1인 이상 승인 필수

Git Convention

  1. 적절한 커밋 접두사 작성
  2. 커밋 메시지 내용 작성
  3. 내용 뒤에 이슈 (#이슈 번호)와 같이 작성하여 이슈 연결
접두사 설명
✨ Feat : 새로운 기능 구현
🚧 WIP : 개발 중
🐛 Fix : 버그 수정
📝 Docs : 문서 추가 및 수정
🎨 Style : 스타일링 작업 및 포맷팅 변경
🔨 Refactor : 코드 리팩토링 (동작 변경 없음)
✅ Test : 테스트 관련
🚀 Deploy : 배포 관련
🔥 Delete : 코드 또는 파일 제거
⚙️ Conf : 빌드, 환경 설정
🚑 Hotfix : 긴급 수정
🎸 Chore : 기타 작업

Pull Request

Title

  • 제목은 '[✨ FEAT] 홈 페이지 구현'과 같이 작성합니다.

PR Type

  • FEAT: 새로운 기능 구현
  • WIP : 에셋 파일 추가
  • FIX: 버그 수정
  • DOCS: 문서 추가 및 수정
  • STYLE: 포맷팅 변경
  • REFACTOR: 코드 리팩토링
  • TEST: 테스트 관련
  • DEPLOY: 배포 관련
  • DELETE: 코드 또는 파일 제거
  • CONF: 빌드, 환경 설정
  • HOTFIX: 긴급 수정
  • CHORE: 기타 작업

Description

  • 구체적인 작업 내용을 작성해주세요.
  • 이미지를 별도로 첨부하면 더 좋습니다 👍

Discussion

  • 추후 논의할 점에 대해 작성해주세요.

Code Convention

BE

  • 패키지명 전체 소문자
  • 클래스명, 인터페이스명 CamelCase
  • 클래스 이름 명사 사용
  • 상수명 SNAKE_CASE
  • Controller, Service, Dto, Repository, mapper 앞에 접미사로 통일(ex. MemberController)
  • service 계층 메서드명 create, update, find, delete로 CRUD 통일(ex. createMember)
  • Test 클래스는 접미사로 Test 사용(ex. memberFindTest)

FE

  • styled-Component 변수명 S + 변수명 (ex. Swrap)
  • styled-Component는 return문 위에 작성
  • 크게는 styled-Component, 그 안에서 className 사용
  • Event handler 사용 (ex. handle ~)
  • export방식 (ex. export default ~)
  • 화살표 함수 사용

Communication Rules

  • Discord 활용
  • 정기 회의

📋 Documents

📜 API 명세서

📜 Swagger 문서

📜 요구사항 정의서

📜 ERD

📜 테이블 명세서

📜 화면 정의서 예시

About

design + subscription

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  

Languages