Merge pull request #97 from boostcampwm-2024/Docs

[ENV][Docs] : 이슈 템플릿 업데이트

.github/ISSUE_TEMPLATE/기능-요청-feature-request--템플릿.md

@@ -0,0 +1,65 @@
+---
+name: 기능 요청(Feature Request) 템플릿
+about: 기능 요청은  자신이 할 일을 큰 범주로 나눌때 써도 되고, 동료에게 작업을 요청할때 쓰면 됩니다.
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+## 📌 요청 기능 설명
+
+> 추가하고자 하는 기능이 무엇인지 간단히 설명해주세요.
+> 예: "사용자 프로필 페이지에 다크 모드 추가"
+
+---
+
+**설명**: 간단하고 명료하게 추가하려는 기능의 개요를 적습니다. 이 부분은 제목과도 연관성이 있어야 하며, 이슈 리스트에서 다른 팀원들이 쉽게 이슈의 내용을 이해할 수 있도록 작성합니다.
+
+---
+
+## 📝 기능 세부 사항
+
+> 기능의 동작 방식과 구체적인 요구사항을 작성해주세요.
+> - 예: 사용자가 다크 모드를 켤 수 있는 토글 스위치가 있어야 함
+> - 예: 다크 모드에서 배경색과 텍스트 색상이 변경되어야 함
+> - 예: 사용자가 설정한 다크 모드 상태가 로컬 저장소에 저장되어야 함
+
+---
+
+**설명**: 기능의 세부사항은 해당 기능이 완성될 때의 모습과 이를 위해 필요한 요소들을 구체적으로 나열합니다. 특히 팀 내에서 동일한 이해를 갖추도록, UI 요소, 상호작용, 데이터 저장 방식 등을 가능한 한 상세히 기술합니다.
+
+---
+
+## 🤔 기능 추가 배경 및 목적
+
+> 왜 이 기능이 필요한지 설명해주세요. 기능이 해결할 문제나 개선될 사항에 대해 적어주세요.
+> 예: "다크 모드는 사용자들에게 더 나은 시각적 경험을 제공하며, 눈의 피로를 줄여줌"
+
+---
+
+**설명**: 기능 요청의 목적을 서술하여, 이 기능이 사용자의 경험을 어떻게 개선할지, 또는 기존 문제를 어떻게 해결할지 설명합니다. 이를 통해 기능의 우선순위와 필요성을 파악할 수 있습니다.
+
+---
+
+## 🚩 완료 조건 (Acceptance Criteria)
+
+> 기능이 완료되었음을 판단할 수 있는 조건을 명확히 정의해주세요.
+> - [ ] 사용자가 프로필 페이지에서 다크 모드를 선택할 수 있음
+> - [ ] 다크 모드 선택 시 배경색과 텍스트 색상이 적절히 변경됨
+> - [ ] 페이지 새로 고침 시에도 다크 모드 상태가 유지됨
+
+---
+
+**설명**: 완료 조건은 이 기능이 완성되었음을 판단할 수 있는 명확한 기준입니다. 체크리스트 형식으로 작성하여 팀원들이 각각의 조건을 충족하는지 쉽게 확인할 수 있게 합니다.
+
+---
+
+## 💡 참고 자료 (선택)
+
+> 관련된 레퍼런스나 문서 링크, UI 디자인 시안, 기타 참고할 수 있는 자료를 첨부해주세요.
+> 예: "디자인 시안 URL", "참고할 라이브러리 링크", "기존 다크 모드 구현 사례 링크"
+
+---
+
+**설명**: 필요한 참고 자료가 있다면 링크나 설명을 추가하여 기능 구현 시 활용할 수 있도록 합니다. 이로써, 개발자는 더 나은 구현 방향을 잡고, 디자이너와 협업할 때 필요한 정보를 쉽게 얻을 수 있습니다.

.github/ISSUE_TEMPLATE/문서화-documentation--템플릿.md

@@ -0,0 +1,64 @@
+---
+name: 문서화(Documentation) 템플릿
+about: 문서화 작성에 앞서서 양식이나 작성 시나리오 등을 서술하는 이슈 템플릿입니다.
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+## 📄 문서화 항목
+
+> 작성할 문서의 이름이나 주제를 간단히 적어주세요.
+> 예: "API 명세 작성", "프로젝트 설치 가이드 작성"
+
+---
+
+**설명**: 작성할 문서의 제목이나 주제를 간단히 요약하여 문서화의 목적을 한눈에 파악할 수 있도록 합니다. 이슈 목록에서 문서화 작업을 쉽게 찾을 수 있게 합니다.
+
+---
+
+## 📝 문서 내용 요약
+
+> 문서에 포함될 내용의 개요를 간단히 설명해주세요.
+> 예: "API 엔드포인트 목록 및 응답 형식을 설명"
+
+---
+
+**설명**: 문서의 핵심 내용을 요약하여 작업의 방향성을 명확히 합니다. 이 항목은 문서가 다루는 주요 내용을 팀원들에게 소개하고, 작업의 큰 그림을 제공하는 역할을 합니다.
+
+---
+
+## 📚 문서 내용 세부 사항
+
+> 문서에 포함될 구체적인 항목을 나열해주세요.
+> - [ ] 사용자 인증 API의 엔드포인트 설명
+> - [ ] 응답 데이터 예시
+> - [ ] 필수 및 선택 매개변수 설명
+> - [ ] 응답 코드 및 에러 처리 방식 설명
+
+---
+
+**설명**: 문서의 세부 항목을 나열하여 필요한 세부 내용을 명확히 정의합니다. 이를 통해 문서 작성자가 각 항목을 빠짐없이 작성할 수 있으며, 다른 팀원들도 문서에서 원하는 정보를 쉽게 찾을 수 있습니다.
+
+---
+
+## 🛠️ 작성 가이드라인 (선택)
+
+> 문서 작성 시 필요한 규칙이나 참고 사항을 추가해주세요.
+> 예: "REST API 명명 규칙에 따라 작성", "데이터 타입 표기를 명확히 할 것"
+
+---
+
+**설명**: 문서화 시 적용할 가이드라인을 설정하여 일관된 문서 스타일을 유지합니다. API 명세의 경우 특정 명명 규칙을 따르거나, 데이터 타입 표기를 명확히 하는 등의 규칙을 제시하면 다른 팀원들이 쉽게 이해할 수 있는 문서가 됩니다.
+
+---
+
+## 🔗 참고 자료 (선택)
+
+> 필요한 경우 외부 레퍼런스 링크나 내부 자료 링크를 첨부해주세요.
+> 예: "REST API 표준 문서 링크", "프로젝트 관련 기술 문서 링크"
+
+---
+
+**설명**: 문서화 작업 시 참고할 자료가 있다면, 링크나 파일 경로를 제공하여 작업자가 쉽게 접근할 수 있게 합니다. 외부 표준 문서, 기술 문서 링크는 정확한 정보를 제공하는 데 유용합니다.

.github/ISSUE_TEMPLATE/버그-보고-bug-report--템플릿.md

@@ -0,0 +1,91 @@
+---
+name: 버그 보고(Bug Report) 템플릿
+about: 버그 발생 시 알리는 템플릿입니다. 보통 바로 수정할 게 아니기에, 재현가능하게 적어야 합니다.
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+## 🐞 버그 설명
+
+> 버그가 무엇인지 간단히 요약해주세요.
+> 예: "로그인 버튼이 클릭되지 않음"
+
+---
+
+**설명**: 이 항목에서는 버그를 간단하게 요약합니다. 이슈 목록에서 다른 팀원들이 빠르게 버그의 개요를 이해할 수 있도록 짧고 명료하게 작성합니다. 특히, "어떤 상황에서 어떤 문제가 발생하는지"를 빠르게 파악할 수 있도록 합니다.
+
+---
+
+## 📋 테스트 환경
+
+> 버그가 발생한 환경에 대해 작성해주세요.
+> - OS / 브라우저: (예: Windows 10 / Chrome 94)
+> - 프레임워크 버전: (예: React 17, Node.js 14)
+> - 기타: (예: 모바일/데스크탑 모드, 네트워크 속도 등)
+
+---
+
+**설명**: 버그가 특정 환경에서만 발생할 수 있으므로, 개발 및 테스트 환경을 명확히 기재하여 문제 재현성을 높입니다. OS, 브라우저, 프레임워크 버전 등의 정보는 같은 환경에서 테스트하고 문제를 확인하는 데 매우 중요합니다.
+
+---
+
+## 📝 버그 상황 설명
+
+> **Given-When-Then** 형식으로 서술해주세요.
+> - Given: 사용자가 로그인 페이지에 접속했을 때
+> - When: 로그인 버튼을 클릭하면
+> - Then: 에러 메시지가 나타나지 않고 페이지가 멈추어야 함
+> 문제 상황 재현을 위해 스크린샷이나 동영상을 첨부해주세요 (선택)
+
+---
+
+**설명**: 버그 상황을 Given-When-Then 형식으로 작성하면 문제가 발생한 상황과 그 조건을 더욱 명확하게 설명할 수 있습니다. 이는 특히 QA팀이나 다른 개발자들이 동일한 문제를 재현하는 데 매우 유용합니다. 스크린샷이나 동영상은 문제를 이해하는 데 큰 도움이 됩니다.
+
+---
+
+## 🚩 재현 방법
+
+> 문제 상황을 재현하기 위해 필요한 단계들을 상세하게 작성해주세요.
+> 1. 로그인 페이지에 접속합니다.
+> 2. 올바른 아이디와 비밀번호를 입력합니다.
+> 3. 로그인 버튼을 클릭합니다.
+> 4. 에러 메시지가 표시됩니다.
+
+---
+
+**설명**: 재현 방법은 버그를 다시 확인할 수 있도록 단계별로 구체적으로 작성합니다. 이를 통해 다른 개발자가 재현 방법만 따라하면 동일한 상황을 쉽게 재현할 수 있습니다.
+
+---
+
+## ✅ 기대 결과
+
+> 예상했던 정상적인 결과가 어떤 것이었는지 설명해주세요.
+> 예: "로그인 버튼 클릭 시 홈 페이지로 리디렉션되어야 함"
+
+---
+
+**설명**: 기대 결과는 문제 상황에서 의도했던 정상적인 동작을 명확히 설명하는 부분입니다. 이를 통해 실제 결과와 비교하여 어떤 점이 정상적이지 않은지 쉽게 파악할 수 있습니다.
+
+---
+
+## 🔍 실제 결과
+
+> 발생한 실제 결과가 무엇인지 설명해주세요.
+> 예: "로그인 버튼을 클릭해도 아무 반응이 없고, 페이지가 고정됨"
+
+---
+
+**설명**: 실제 결과는 발생한 문제의 구체적인 증상을 설명하는 부분입니다. 기대 결과와의 차이를 명확히 설명하면, 문제 해결에 더욱 도움이 됩니다.
+
+---
+
+## 💡 참고 자료 (선택)
+
+> 문제와 관련해서 참고할만한 자료를 적어주세요.
+> 예: 로그 파일, 오류 메시지, 관련된 이슈 링크
+
+---
+
+**설명**: 추가적인 로그 파일이나 관련 이슈 링크가 있다면, 여기에 작성하여 문제 해결에 필요한 정보를 더 많이 제공할 수 있습니다. 이 정보는 개발자가 문제의 원인을 더욱 쉽게 파악할 수 있도록 도와줍니다.

.github/ISSUE_TEMPLATE/작업-task--템플릿.md

@@ -0,0 +1,78 @@
+---
+name: 작업(Task) 템플릿
+about: '기능 요청사항에 대한 세분화한, 실제 개발 단위인 Task에 관한 문서입니다. '
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+## 📌 작업 제목
+
+> 작업의 이름을 간단히 적어주세요.
+> 예: "헤더 컴포넌트 구현"
+
+---
+
+**설명**: 작업의 제목은 간결하고 직관적으로 작성하여 이슈 목록에서 쉽게 파악할 수 있도록 합니다. 특정 기능 개발, 디자인 조정, 코드 리팩토링 등 다양한 작업에 적용될 수 있습니다.
+
+---
+
+## 🎯 목표
+
+> 이 작업의 목표나 목적을 설명해주세요.
+> 예: "헤더 컴포넌트를 구현하여 모든 페이지에 통일된 네비게이션을 제공"
+
+---
+
+**설명**: 작업의 목표는 이 작업이 프로젝트에서 수행하는 역할과 그 필요성을 설명합니다. 이를 통해 팀원들이 작업의 중요도와 필요성을 이해할 수 있습니다.
+
+---
+
+## 📝 작업 세부 사항
+
+> 작업에 대한 구체적인 내용을 작성합니다.
+> - 컴포넌트 구조
+> - UI 스타일
+> - 데이터 흐름
+> - 예: 헤더 컴포넌트는 로고, 네비게이션 메뉴, 검색창으로 구성되어야 함
+
+---
+
+**설명**: 작업의 세부 사항은 필요한 요소와 구현 방식에 대해 명확히 서술하여 작업의 완성도를 높입니다. UI 요소, 데이터 흐름, API 요청 등의 구체적인 요구사항을 나열하여 팀원들이 작업을 진행할 때 참고할 수 있도록 합니다.
+
+---
+
+## 🚩 완료 조건 (Acceptance Criteria)
+
+> 작업 완료를 판단할 수 있는 기준을 명확히 작성해주세요.
+> - [ ] 헤더 컴포넌트가 페이지 상단에 고정됨
+> - [ ] 모바일 및 데스크탑에서 반응형 동작이 잘 작동함
+> - [ ] 네비게이션 메뉴가 모든 페이지에서 일관되게 동작함
+
+---
+
+**설명**: 완료 조건은 작업이 완성되었음을 확인할 수 있는 체크리스트 형태로 작성하여 작업의 명확한 종료 시점을 제공합니다. 이를 통해 QA 및 다른 팀원들이 작업 완료 여부를 쉽게 확인할 수 있습니다.
+
+---
+
+## 📅 예상 소요 시간 및 일정
+
+> 예상 소요 시간을 작성해주세요 (예: 2일, 5시간 등)
+> 작업을 시작 및 완료할 예상 일정을 간단히 작성하면 더욱 좋습니다.
+> 예: "이 작업은 2일이 소요될 예정이며, 이번 주 내로 완료 예정"
+
+---
+
+**설명**: 예상 소요 시간과 일정을 작성하여 작업의 우선순위와 마일스톤을 설정하는 데 도움이 됩니다. 또한, 작업의 진행 상황을 추적할 수 있어 프로젝트 일정 관리에 유용합니다.
+
+---
+
+## 💡 참고 자료 (선택)
+
+> 필요한 경우 외부 레퍼런스 링크나 내부 자료 링크를 첨부해주세요.
+> 예: "헤더 디자인 시안 URL", "참고할 UI 라이브러리 링크"
+
+---
+
+**설명**: 작업에 필요한 참고 자료가 있다면, 여기에 첨부하여 개발자가 작업을 진행할 때 필요한 자료를 손쉽게 찾아볼 수 있게 합니다. 디자인 시안, 유사한 UI/UX 구현 링크, 외부 라이브러리 참고 자료 등이 유용할 수 있습니다.