Skip to content

2. 구현

seonwoo edited this page Jul 25, 2023 · 3 revisions

2.1 Development

Front-end와 Back-end에서 사용한 기술 스택과 라이브러리에 대해 소개한다. 추가로, DevOps에 대한 내용은 시스템 아키텍처 구축 완료 후 추가할 예정이다.


기술 스택

아이콘 기술 스택
TypeScript
React.js
Visual Studio Code

라이브러리

라이브러리 버전

기술 스택

아이콘 기술 스택
Java
Spring Boot
IntelliJ

라이브러리

라이브러리 버전


2.2 Conventions

  • 여기서는 구현에 필요한 각종 컨벤션(Convention)에 대해 요약하고 있다.
  • 보다 자세한 컨벤션(Convention) 내용은 컨벤션을 정리한 문서 링크를 참고하면 된다.

📌 Git/GitHub Conventions

  • 양식 1) Jira를 사용하지 않는 경우 (실제로 작성할 때는 주석을 생략한다.)
# 제목 (type: Subject)
feat: Add a recycler view

# 한 줄 띄우기

# 본문 (Body) (생략 가능)
recycler view that show photo list.

# 한 줄 띄우기

# 꼬리말 (Footer) (생략 가능)

  • 양식 2) Jira를 사용하는 경우 (실제로 작성할 때는 주석을 생략한다.)
# Jira 이슈(Ticket) 번호: REL-01
# 유형(Type): feat
# 제목(Subject): Add a recycler view
REL-01 feat: Add a recycler view

# 한 줄 띄우기

# 본문 (Body) (생략 가능)
- recycler view that show photo list.
- optimize recycler view

# 한 줄 띄우기

# 꼬리말 (Footer) (생략 가능)

  • Commit Type
태그 이름 설명
feat 새로운 기능 추가
fix 버그/오류 수정
design CSS 등 사용자 UI 디자인 변경
style 코드 포맷 변경, 세미콜론 누락, 코드 수정이 없는 경우
refactor 프로덕션 코드 리팩토링
comment 필요한 주석 추가 및 변경
docs 문서 수정 (예: README.md)
test 테스트 추가, 테스트 리팩토링 (프로덕션 코드 변경 X)
!BREAKING CHANGE 커다란 API 변경의 경우
!HOTFIX 급하게 치명적인 버그를 고쳐야 하는 경우
chore 빌드 업무 수정, 패키지 매니저 설정, 패키지 관리자 구성 등 업데이트 (프로덕션 코드 변경 X)
rename 파일 혹은 폴더명을 수정하거나 옮기는 작업만인 경우
remove 파일을 삭제하는 작업만 수행한 경우

  • 양식
프로젝트명-서비스-프레임워크-언어

✓ 소문자를 사용하기
✓ 대시(hyphens, -)를 사용하기
✓ 이때 ‘언어’ 부분은 옵션으로 두어도 괜찮다.
✓ 예) releaser-backend-springboot-java, releaser-frontend-react-ts 등


  • 작성 중 (2023-07-25 (화) 기준)

  • 작성 중 (2023-07-25 (화) 기준)