[Pre-Project] Day 3 : 초기 설정 및 사용자 요구사항 정의서

Day1에는 팀 구성 및 빌딩을 그리고 Day2에는 GitHub을 다시 잡고 이제 프로젝트에 드디어 입성(?)하였다.

따라서 이제 프로젝트를 하나씩 기록하려고 한다.

프로젝트를 하는 과정에 있어서 잘못된 부분이 있으면 계속해서 수정할 예정!

---

✅ Commit convention 정리 및 추가 규칙 정리

• 브랜치 정리 : main, dev-fe, dev-be, feat/이슈번호-키워드
• 커밋 컨벤션 정리 : feat, refactor, docs, fix, test, chore, style
• 커밋 할 때 지키면 좋은 것 : https://meetup.toast.com/posts/106 참조하여 wiki에 정리
• 규칙 및 컨벤션 등은 GitHub wiki에 정리

---

✅ 사용자 요구사항 정의서

• 시스템의 요구사항을 도출하여 발주자와 내용을 합의
• 하나의 업무 단위로서 가치를 가지고 수행될 수 있는 업무를 도출하여 업무 내용을 기술

사용자 요구사항 정의서 예시

• 구분 : 도출된 요구사항을 기능 / 성능 / 품질 / 인터페이스 / 데이터 / 운영 / 제약사항 중에서 선택하여 기재
• 요구사항 ID : 요구사항별로 유일한 ID를 부여하여 기입
• 요구사항 명 : 도출된 요구사항을 요약할 수 있는 명칭을 기입
• 기능 명 : 요구사항에서 한 단계 더 들어간 세부 기능명을 명시
• 중요도 : 해당 요구사항의 전체 시스템 구현 측면에서의 중요도를 기술
• 필수 데이터 : 기능별 입력되어야 할 필수 데이터
• 선택 데이터 : 기능별 선택적으로 입력할 데이터
• 비고 : 항목에 포함되지 않으나, 고려해야 할 사항이 있으면 기술

참고한 자료 : 유어클래스 + 아래 블로그

[요구사항 정의서] 작성하는 법

---

✔️ Check Today

1️⃣ 2022.10.24

      ✓ 사용자 요구사항 정의를 적을 범위를 설정

      ✓ 사용자 요구사항 정의를 큰 틀에서만 작성

      ✓ 세부 사항은 내일 오전 회의를 통해 작성 예정

2️⃣2022.10.25

      ✓ 기능에 관련된 내용 정리

      ✓ 필수 데이터는 지금 당장 쓰지 않고, 필요시 추가

      ✓ 프론트엔드에 필요한 내용 정리

---

✅ 초기 설정

☝🏻컨벤션 정하기

       ✓ 네이버 컨벤션 참조

         (참조 : https://naver.github.io/hackday-conventions-java/ )

       ✓ Intelli J IDE에 컨벤션 적용 및 체크 기능 확인

        (참조 :   https://bestinu.tistory.com/64 )

 

✌🏻package 나누기

       ✓ 도메인 먼저 (예 : user, question, answer 등)

       ✓ 도메인 하위에서 계층 별로 분리 (예 : controller, service, repository 등)

 

🤟🏻 build.gradle 파일에 dependencies 추가

       ✓ lombok (❗️ annotationProcessor)

       ✓ spring web

       ✓ validation

       ✓ data jpa

       ✓ rest docs / asciidoctors

       ✓ spring security

       ✓ oauth2 client

       ✓ mapstruct  (❗️ annotationProcessor)

       ✓ gson

       ✓ jwt

       ✓ h2 database

 

✌🏻✌🏻 application.yml 파일 설정

       ✓ H2 데이터 베이스 사용을 위한 설정

       ✓ 스키마 자동 생성

       ✓ SQL 쿼리 출력

 

spring:
  h2:
    console:
      enabled: true
      path: /h2
  datasource:
    url: jdbc:h2:mem:test
  jpa:
    hibernate:
      ddl-auto: create 
    show-sql: true  
    properties:
      hibernate:
        format_sql: true 
  sql:
    init: