From ccc9565455f7d79be66b8707b4371ba5988f0a52 Mon Sep 17 00:00:00 2001 From: Zen <107134031+effozen@users.noreply.github.com> Date: Wed, 6 Nov 2024 16:57:39 +0900 Subject: [PATCH] =?UTF-8?q?[ENV][Docs]=20#1=20:=20PR=20=ED=85=9C=ED=94=8C?= =?UTF-8?q?=EB=A6=BF=20=EC=9E=91=EC=84=B1?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit PR 요청 시 관련 템플릿입니다. --- ...r-\355\205\234\355\224\214\353\246\277.md" | 87 +++++++++++++++++++ 1 file changed, 87 insertions(+) create mode 100644 ".github/ISSUE_TEMPLATE/pr-\355\205\234\355\224\214\353\246\277.md" diff --git "a/.github/ISSUE_TEMPLATE/pr-\355\205\234\355\224\214\353\246\277.md" "b/.github/ISSUE_TEMPLATE/pr-\355\205\234\355\224\214\353\246\277.md" new file mode 100644 index 00000000..fbcd3483 --- /dev/null +++ "b/.github/ISSUE_TEMPLATE/pr-\355\205\234\355\224\214\353\246\277.md" @@ -0,0 +1,87 @@ +--- +name: PR 템플릿 +about: PR 날릴 때 사용하시면 됩니다. +title: '' +labels: '' +assignees: '' + +--- + +## 📝 PR 개요 + +> 이 PR에서 어떤 변경이 이루어졌는지 간략히 설명해주세요. +> 예: "로그인 페이지 UI 개선 및 다크 모드 추가" + +--- + +## 🔍 변경 사항 + +> PR에서 변경된 주요 내용을 구체적으로 설명해주세요. +> - 로그인 페이지의 레이아웃을 수정하여 사용자 경험 개선 +> - 다크 모드 기능 추가 및 상태 관리 로직 구현 +> - 테스트 코드 추가로 다크 모드 기능 검증 + +--- + +**설명**: 이 항목에서는 코드의 주요 변경 사항을 나열하여 리뷰어가 코드 수정의 목적을 쉽게 파악할 수 있도록 합니다. 변경된 주요 로직이나 UI 수정 사항이 있다면 구체적으로 설명합니다. + +--- + +## ✅ 체크리스트 (Checklist) + +- [ ] 코드가 빌드 오류 없이 잘 작동하는지 확인 +- [ ] 테스트가 통과하는지 확인 +- [ ] 스타일 가이드와 일관성을 유지했는지 확인 +- [ ] 관련 문서가 업데이트되었는지 확인 (선택 사항) +- [ ] 리뷰어가 이해할 수 있도록 주석이나 설명을 추가했는지 확인 + +--- + +**설명**: 이 체크리스트는 PR 작성자가 스스로 점검할 수 있는 기준을 제시합니다. 코드가 빌드 오류 없이 작동하고, 테스트를 통과하며, 스타일 가이드를 따르고 있는지 확인하는 항목들입니다. + +--- + +## 🔄 관련 이슈 (Linked Issues) + +> 이 PR과 관련된 이슈 번호를 적어주세요. (예: #123) +> 예: "다크 모드 기능 요청 이슈(#45) 해결" + +--- + +**설명**: 이 PR과 관련된 이슈 번호를 링크하여 리뷰어가 관련된 문제나 요청 사항을 쉽게 참고할 수 있도록 합니다. 이를 통해 이슈와 PR을 연결하여 작업의 목적을 명확히 할 수 있습니다. + +--- + +## 📷 스크린샷 및 동영상 (선택 사항) + +> UI 변경 사항이 있는 경우 스크린샷이나 동영상을 첨부해주세요. +> 예: 변경된 로그인 페이지 화면 캡처 + +--- + +**설명**: UI 변경 사항이 포함된 경우, 변경된 화면을 시각적으로 보여주기 위해 스크린샷이나 동영상을 첨부하면 도움이 됩니다. 리뷰어는 화면 변경 사항을 바로 확인할 수 있어 코드 리뷰가 더 효과적입니다. + +--- + +## 🧪 테스트 방법 + +> 변경 사항을 검토할 때 어떻게 테스트해야 하는지 단계별로 설명해주세요. +> 예: +> 1. 로그인 페이지로 이동합니다. +> 2. 다크 모드 스위치를 클릭합니다. +> 3. 배경색이 다크 모드로 변경되는지 확인합니다. + +--- + +**설명**: 코드 변경 사항을 검토할 때 사용할 테스트 방법을 구체적으로 설명하여, 리뷰어가 쉽게 테스트를 수행할 수 있도록 합니다. 특정 기능이나 UI 요소에 대한 테스트 방법을 안내하면 코드 리뷰 속도가 빨라집니다. + +--- + +## 📚 참고 자료 (선택 사항) + +> PR과 관련된 참고 자료가 있다면 링크나 설명을 첨부해주세요. +> 예: "다크 모드 구현을 위한 라이브러리 사용 가이드 링크" + +--- + +**설명**: 참고할 자료가 있다면 여기에 적어 리뷰어가 필요한 경우 해당 자료를 참조할 수 있게 합니다. 외부 라이브러리나 참고할 문서, API 명세 링크 등이 포함될 수 있습니다.