[Git] 이슈(Issue) 템플릿 작성하기

angie·2024년 3월 18일
0

Git/Github

목록 보기
1/1

1. issue란?


소프트웨어 개발 및 프로젝트 관리에서 발생하는 작업, 버그, 기능 요청 등과 같은 사항을 추적하고 관리하는 데 사용되는 개념이다. 이슈는 프로젝트의 진행 상황을 추적하고 문제를 해결하는 데 도움이 된다.

일반적으로 이슈는 다음과 같은 경우에 사용 된다.

  • 버그 신고: 사용자 또는 테스터가 발견한 버그를 설명하고 추적한다.
  • 새로운 기능 요청: 사용자 또는 이해관계자가 프로젝트에 새로운 기능을 제안하고 요청한다.
  • 작업 항목: 프로젝트 내에서 수행해야 할 작업을 추적하고 할당한다.
  • 기존 작업의 수정 또는 업데이트: 이미 진행 중인 작업의 수정이나 업데이트 사항을 기록한다.
  • 토론 및 의견 공유: 프로젝트 팀원 간에 토론하고 의견을 공유하는 데 사용된다.

이슈는 일반적으로 이슈 트래커(예: GitHub, GitLab, Jira 등)를 통해 관리한다.

2. issue 템플릿 작성하기


이슈 작성의 일관성을 유지하고 반복적인 작업을 줄이기 위해 issue 템플릿을 만들어 볼 것 입니다.

1. 깃 상단 setting -> set up templates 을 클릭합니다.

2. 각 issue에 맞게 작성할 수 있습니다. 저는 Feature 이슈를 만들 것입니다.

3. 제목 옆에 연필을 클릭 해 자신이 원하는대로 편집할 수 있습니다. 저는 아래와 같은 형식으로 작성하였고 다 작성한 후 Propose changes를 눌러줍니다.

✅FEATURE
Feature 작업 사항을 입력해주세요.
## Desciption
설명을 작성하세요.

## Todo
- [ ] todo
- [ ] todo

## ETC
기타사항

4. 이후 New issue를 누르면 생성된 템플릿을 사용할 수 있고 파일은 .github/ISSUE_TEMPLATE 내에서 볼 수 있습니다.

profile
열심히 달리는 개발자

0개의 댓글

Powered by GraphCDN, the GraphQL CDN