Skip to content

Commit

Permalink
Merge pull request #6 from UMC-HACKATHON-SnapSpot/feat/#4
Browse files Browse the repository at this point in the history
docs: README 문서 초안 업데이트
  • Loading branch information
wonjun0120 authored Jul 4, 2024
2 parents 1804481 + 681deec commit 00de31d
Showing 1 changed file with 34 additions and 2 deletions.
36 changes: 34 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,28 @@
# server
# SnapSpot-server

## Table of Contents

- [Intro](#intro)
- [Branch](#branch)
- [Commit](#commit)
- [Deploy](#deploy)
- [Database](#database)

## Intro

이 레포지토리는 UMC Hackaton의 SnapSpot 서비스의 서버 코드를 관리하는 레포지토리 입니다.


## Branch

`main` : 운영 상태의 코드를 관리하는 메인 브랜치입니다.

`dev` : 개발 레포지토리의 브랜치입니다. 새로운 기능을 추가하는 경우 꼭 이 브랜치에서 새로운 브랜치를 만들어야합니다.

`feat/#{issuenumber}` : 새로운 기능을 만드는 경우 dev브랜치에서 생성하는 브랜치입니다. 깃허브 이슈 카드에서 브랜치를 생성하며,
이슈 번호로 브랜치를 수정하여 생성합니다.

`fix/#{issuenumber}` : 버그수정이나 기능 수정이 일어나는 경우 main 브랜치에서 생성하는 브랜치입니다.

## Commit
커밋 메시지 형식
Expand Down Expand Up @@ -37,4 +61,12 @@ Body (본문)은 최대한 상세히 적고, 무엇을 왜 진행했는 지 설

**Footer (꼬리말)**

Footer (꼬리말)은 관련 깃허브 이슈번호를 작성합니다.
Footer (꼬리말)은 관련 깃허브 이슈번호를 작성합니다.

## Deploy

dev 브랜치에 push하게 되면 github actions을 통해 자동으로 배포가 진행됩니다.


## Database
데이터베이스의 스키마는 [dbdiagram](https://dbdiagram.io/d/SnapSpot-668646ed9939893dae03d3c7) 에서 관리되고 있습니다.

0 comments on commit 00de31d

Please sign in to comment.