(3D)Dev Deep Dive/Templates & Guides

[Template] Issue Template

  • -
728x90

Issue Template은 프로젝트 관리 및 협업 툴에서 사용되는 미리 정의된 형식의 템플릿으로, 팀원들이 일관된 정보를 공유하고 문제를 신속하게 해결할 수 있도록 돕습니다

일반적으로 GitHub, GitLab, Jira 등의 협업 도구에서 사용됩니다


Issue Template의 장점들

  1. 일관성
    • 템플릿을 사용하면 팀원들이 동일한 형식을 따르도록 유도하여 일관된 이슈 제출을 돕습니다. 이로 인해 정보 공유가 더 효과적이고 효율적으로 이루어집니다.
  2. 효율성
    • 템플릿에 필요한 정보가 미리 명시되어 있어, 팀원들이 이슈를 보다 신속하게 작성하고 해결할 수 있습니다.
  3. 커뮤니케이션 개선
    • 모든 관련 정보가 한 곳에 모여 있어, 이슈에 대한 논의와 해결 과정에서 오해가 줄어듭니다.
  4. 시간 절약
    • 이슈를 작성하는 데 걸리는 시간이 줄어들어, 팀원들이 더 많은 시간을 개발에 집중할 수 있습니다.

사용할 수 있는 Issue Template은 다음과 같습니다(GitHub, 예시)

title: [Feature] 로그인 기능 구현
---

**기능 요청에 대한 설명**
새로운 기능에 대한 명확하고 간결한 설명을 작성해 주세요.
(예: 로그인 이중 인증 구현)

**해결하고자 하는 문제**
이 기능이 해결하고자 하는 핵심 문제나 요구사항을 설명해 주세요.
(예: 이중 인증은 휴대폰 번호로 진행)

**제안하는 해결책**
원하는 기능 구현에 대한 아이디어나 제안을 자세히 작성해 주세요. 
가능하다면, 기술적인 세부 사항도 포함해 주세요.
(예: 특정 번호에 랜덤한 인증 번호를 보내주는 라이브러리를 사용)

**대안적인 해결책**
제안하는 기능 외에 고려해볼만한 다른 방법이나 아이디어가 있다면, 여기에 작성해 주세요.
(예: 이메일 인증 방법을 통해 이중 인증하기)

**추가 정보**
기능 요청과 관련된 추가 정보나 스크린샷 등이 있다면 첨부해 주세요.

End

728x90
Contents

포스팅 주소를 복사했습니다

이 글이 도움이 되었다면 공감 부탁드립니다.