From 23f6be3f830ee47e9c5960fbeeea5717cbbe5817 Mon Sep 17 00:00:00 2001 From: SSH9753 <80192612+SSH9753@users.noreply.github.com> Date: Sat, 4 Nov 2023 20:11:24 +0900 Subject: [PATCH] =?UTF-8?q?Contributing=20Guide=20=EC=B6=94=EA=B0=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/README.md b/README.md index 6e978b5..e99078b 100644 --- a/README.md +++ b/README.md @@ -88,3 +88,39 @@ ## API 명세 [Swagger API 명세](https://test.emopic.shop/swagger-ui/index.html) ![화면 캡처 2023-09-07 212846](https://github.com/Memento-Makers/Emopic-BE/assets/80192612/45fcbb3d-942c-4fe8-b41e-9f072e14f1a0) + +# 시작하기 +## 설치 +프로젝트의 원격 저장소를 Fork 하여 깃허브 내계정으로 복사하기. + +Fork된 저장소를 git clone 명령으로 로컬 환경에 복사. + +환경변수 설정 + +## 기여하기 + +### 이슈생성 +이슈를 생성 하기 전에 최신 버전의 프로젝트를 사용하고 있는지 확인하세요. + +관련 이슈가 이미 존재하지 않는 경우 관련 [이슈 양식](.github/ISSUE_TEMPLATE)을 사용하여 새 이슈를 열 수 있습니다. + +### 브랜치(Branch) 만들기 +기능 개선이나 추가,버그 수정 등의 작업을 위해 별도의 브랜치를 만들어 진행할 수 있습니다. +```bash +git branch [branch명] +git checkout [branch명] +``` +### 커밋 메시지 작성 +브랜치에 작업한 내용이 만족스러우면 커밋 메시지를 작성하고 push 할 수 있습니다. +커밋 메시지 작성시 작성 양식을 따라 주세요. + +### Pull Request 작성 +변경이 완료되면 Pull Request 요청을 생성할 수 있습니다. + +Pull Request 작성시 [작성 양식](.github/pull_request_template.md)을 따라 주세요. + +작성 시 주의사항은 다음과 같습니다. +1. 제목은 해결하려는 이슈가 무엇인지 누구나 파악할 수 있도록 간명하게 작성한다. +2. 관련된 이슈가 있을 경우 해당 이슈의 게시물 번호를 함께 명시해준다. +3. 해결하려는 이슈의 간략한 내용, 수정/개선 방향등의 내용을 요약해서 작성한다. +4. 가급적 공손한 어투로, 무례하거나 공격적으로 느껴지지 않도록 작성한다.