팀명 : 팔레트

프로젝트 명 : 팔레트

한 줄 소개 : 팔레트처럼 다양한 프로젝트 아이디어와 작업을 간편하게 한눈에 펼쳐 보여주는 Kanban 보드 프로젝트 협업 솔루션 서비스 제공

기능요약 :

• 사용자가 협업에서 Backlog 설정과 Backlog Process Status를 Backlog 카드와 Status 컬럼간 CRUD로 Status 최신화
• 협업 Board 내 Process 별 상세 내용 간편 조회 및 전체 Process 파악
• 사용자간 Backlog에 대한 아이디어 공유

와이어 프레임

https://nbcamp2024.slack.com/files/U06JNQBPRL3/F07CFFMQ8LQ/a08.png

ERD 다이어그램

API 명세서

API 명세서

코드 컨벤션

파일 및 변수 네이밍 컨벤션

종류	설명	예시
package	모두 소문자, 한 단어	example
class	파스칼 케이스	ExampleTest
interface	파스칼 케이스	ExampleTest
method	카멜 케이스	exampleTest
variable	카멜 케이스	exampleTest
constant	모두 대문자, 문자 사이는 언더바(_) 사용	EXAMPLE_TEST
boolean	카멜케이스	exampleTest

패키지 네이밍 컨벤션(추후수정)

종류	설명
controller	컨트롤러 계층
service	서비스 계층
repository	레포지토리 계층
dto	DTO 객체
entity	Entity
security	security 필터 및 security에 사용되는 객체
exception	서버 전역 및 filter Exception Handler
config	서버 config
jwt	jwt 생성 및 검증

코딩 컨벤션

• 줄 띄우기 구분
  • 필드 구분(맨 윗줄만 한 줄 띄우고, 필드는 전부 붙여쓰기)
  • 메서드 간의 구분 (1줄 띄우기)
  • return 등 한줄만 있는 메서드 일 경우, 붙여서 정리

    public Object test() {
            return null; // 한줄로 붙이기
         }

  • if 문 등 조건 문은 인텔리제이 자동정렬 기준으로 정리

    // example
     if (test == 0) {
                return null;
            }

• 주석 처리
  • 최대한 불필요한 주석 지양
  • 반드시 공유를 해야하는 중요한 주석 기재 후, 프로젝트 마무리에 전부 정리
• 연산자 좌우 한 칸 띄우기 인텔리제이 자동정렬 기능 활용

깃허브 룰

Github Rules

깃허브 규칙

Organization & Issues

1. To do List 관련 Issues 작성

   ex) A 기능의 CRUD 전체가 한 Issue

2. GitHub 커밋 메시지 규칙에 의해 Commit

3. GitHub Kanban Board 활용

Repository 및 PR

1. 기능 구현이 완료된 후에는 dev PR Merge 시, 한 명 이상이 코드 리뷰를 진행 후 진행
   • 자기 자리 시계방향 기준
2. 본인의 Conflict는 스스로 해결 후, 다시 코드 리뷰 후 PR Merge
   • 서로 도와주기

Branch 네이밍

• GitHub Issues 번호 (Projects 에서 생성시 부여된 번호) 로 Branch 를 만들어서 작업후, PR

 feature/#4

깃헙 커밋 메시지 규칙

작업 타입 & 작업 내용

작업 타입	작업내용
🎀 feat	새로운 기능이 생김
✨ update	해당 파일에 새로운 기능이 추가 구현
🎉 add	없던 파일을 생성함, 초기 세팅
🩹 fix	코드 수정
♻️ refactor	코드 리팩토링
🔥 del	기능/파일을 삭제
🚚 move	파일 옮김/정리
🍻 test	테스트 코드를 작성
💄 style	css
🙈 gitfix	gitignore 수정
🔨script	package.json 변경(npm 설치 등)
🐛 bugfix	버그 수정

Commit Message 규칙

[#이슈번호] '작업 타입' : '작업 내용'

**[#36]** 🎀 **feat : 회원가입 기능 추가**

-구체적인 내용1
-구체적인 내용2
-구체적인 내용3

• 구체적인 내용이 있을 경우을 아래에 작성
• 여러 줄의 메시지를 작성할 땐 "-"로 구분