Skip to content

Commit

Permalink
[chore] Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
PicturePark1101 authored Jan 9, 2025
1 parent 7844905 commit ac9ad1a
Showing 1 changed file with 34 additions and 32 deletions.
66 changes: 34 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,48 +1,50 @@
### type

# About 주인장
![주인장기획서이미지](https://github.com/user-attachments/assets/b2e72c8f-0425-4571-946e-866cf56704ac)

- add : 새로운 파일 추가
- feat : 만들어진 파일에 새로운 기능 추가, 수정기존의 기능을 요구 사항에 맞추어 수정
- fix : 기능에 대한 버그 수정
- build : 빌드 관련 수정
- chore : 패키지 매니저 수정, 그 외 기타 수정 ex) .gitignore
- ci : CI 관련 설정 수정
- docs : 문서 수정
- comment : 주석 추가
- style : 코드 스타일, 포맷팅에 대한 수정
- refactor : 기능의 변화가 아닌 코드 리팩터링 ex) 변수 이름 변경
- test : 테스트 코드 추가/수정
- release : 버전 릴리즈
- remove : 코드 또는 파일, 리소스 제거
-
## `Commit message`
# Backend Team

예시 : `**add : 이미지 파일 추가 #223**`
| 코난 ([hyeonahhh](https://github.com/hyeonahhh)) | 시니 ([2hy2on](https://github.com/2hy2on)) | 여니 ([yeon015](https://github.com/yeon015)) | 진 ([PicturePark1101](https://github.com/PicturePark1101)) |
|--------------------------------------------------|--------------------------------------------|---------------------------------------------|----------------------------------------------------------|
| <img src="https://github.com/user-attachments/assets/f9cf4cdb-0e39-4b53-aa2d-92bb5e81bb72" width="300"/> | <img src="https://github.com/user-attachments/assets/9f41cd55-0b63-4bfb-b91c-4f6473548122" width="300"/> | <img src="https://github.com/user-attachments/assets/153a7961-97fa-46da-87d0-214f52710ac3" width="300"/> | <img src="https://github.com/user-attachments/assets/50e1e9fd-d687-4416-81ed-950105551a74" width="300"/> |
| ● 녹음 관련 API <br> ● 체크리스트 관련 API| ● Spring Security, JWT 기반 인가 인증 구현<br> ● Oauth 연동 Kakao, Apple 로그인 구현 <br> ●CI/CD 구축| ● Spring Security, JWT 기반 인가 인증 구현<br> ● Oauth 연동 Kakao, Apple 로그인 구현 |● 임장 관련 API<br> ● Prometheus & Grafana 기반 모니터링 구축|

## `issue`

[type]작업 내용

예시 : `**[fix]로그인 에러 고침**`
# Architecture
![아키텍쳐22](https://github.com/user-attachments/assets/29561ca0-7194-4ac9-aa65-1a04cad7e410)

## `branch`
# Stack
![주인장리드미](https://github.com/user-attachments/assets/e57dbed8-d923-40f6-91cc-04ecda91f96b)

type/작업내용

예시 : `**fix/login error**`
# Convention

branch명은 한글로 작성 시 깨질 수 있음. 영문으로 작성할 것.
## tag type

## `pr`
| 유형 | 설명 |
|------------|----------------------------------------------------------------------|
| **add** | 새로운 파일 추가 |
| **feat** | 만들어진 파일에 새로운 기능 추가, 수정. 기존 기능을 요구 사항에 맞게 수정 |
| **fix** | 기능에 대한 버그 수정 |
| **build** | 빌드 관련 수정 |
| **chore** | 패키지 매니저 수정, 기타 수정 (ex: `.gitignore`) |
| **ci** | CI 관련 설정 수정 |
| **docs** | 문서 수정 |
| **comment**| 주석 추가 |
| **style** | 코드 스타일, 포매팅 관련 수정 |
| **refactor**| 기능 변화 없이 코드 리팩터링 (ex: 변수 이름 변경) |
| **test** | 테스트 코드 추가/수정 |
| **release**| 버전 릴리즈 |
| **remove** | 코드 또는 파일, 리소스 제거

[type/#이슈번호]작업내용

예시 :`**[fix/#223]로그인 에러 고침**`
## Commit message

**pr시 자신이 작업한 내용 자세하게 써주어야 함!!**
[type : 작업내용 #이슈번호] <br>
예시 : `add : 이미지 파일 추가 #223`

## `merge`
## branch

시니 ← 진 ← 코난 ← 여니 ex( 진이 시니 PR merge, 여니가 시니 PR merge

merge 할 때 delete branch 해주세용
type/작업내용 <br>
예시 : `fix/loginerror`

0 comments on commit ac9ad1a

Please sign in to comment.