[GitHub] 애자일(Agile)스럽게 팀프로젝트 준비하기1 - 이슈(Issue) 등록과 템플릿 설정

🌟 애자일(Agile)

애자일(Agile) 방법론은 소프트웨어 개발에서 유연하고 반복적인 접근 방식을 강조하는 프로젝트 관리 방법이다.

이 방법론에서는 짧은 개발 주기(스프린트)를 통해 개발과 함께 즉시 피드백을 받아, 팀의 협업과 의사소통을 강화한다.

 

 

그렇다면 이슈를 등록하고 사용하는 것이 왜 애자일스러운 방법일까?

1. 투명성 및 가시성: 이슈 트래커를 통해 현재 진행 중인 작업, 남은 작업, 발생한 문제 등의 진행 상황을 실시간으로 파악 가능
2. 지속적인 피드백 및 우선순위 관리: 이슈를 통해 발견되 버그나 기능 요청에 대한 빠른 피드백 반영과 우선 순위 조정에 유용
3. 작은 단위의 작업 관리: 이슈 트래커를 사용하면 기능, 버그, 개선 사항 등을 각각의 이슈로 나눠 관리 가능
4. 지속적인 개선: 발견된 문제점이나 개선 사항을 기록하고, 이를 해결하는 과정을 통해 지속적으로 개선 가능

---

📌 이슈로 등록하는 항목들

• 버그(Bug): 코드의 오류로 인해 발생하는 문제들을 기록.
• 기능 추가(Feature Request): 새로운 기능이나 개선 사항을 제안.
• 개선 사항(Improvement): 기존 기능의 성능 향상이나 코드 최적화 등.
• 작업(Task): 코드 리팩토링, 문서 업데이트 등
• 질문(Question): 프로젝트와 관련된 질문이나 토론 주제를 제안.
• 문서화(Documents): 코드 문서화 작업이나 README 업데이트.
• 테스트(Test): 테스트 관련 이슈, 예를 들어 특정 기능에 대한 테스트 추가.

---

📌 이슈 컨벤션 템플릿

- 새로운 기능 추가 시

## 💡추가할 기능
<!-- 진행할 작업에 대한 간단한 설명해주세요. -->

## 🌿  To-do
<!-- 구현하기 위해 할 내용을 적어주세요. -->
- [ ] todo

## 📌 ETC
<!-- 기타 사항을 적어주세요. -->

 

 

- 버그 발생 시 

## 🚨 발생한 버그 
<!-- 발생한 버그 내용을 설명해주세요. -->

## 🌿  재현 과정
<!-- 어떤 상황에 버그가 발생하는지 작성해주세요. -->

## 🛠️ 예상하는 정상 작동
<!-- 정상 작동시 어떤 결과가 나와야 하는지 작성해주세요. -->


## 📸 스크린샷
<!-- 가능하다면 스크린샷을 첨부해주세요.  -->


## 📌 ETC
<!-- 기타 사항을 적어주세요. -->

 

 

- 리팩토링 작업 시 

## Description
설명을 입력해주세요.


## Before
변경전의 상황과 변경하려는 이유를 작성해주세요.


## After
변경후의 예상하는 구조를 작성해주세요.


## Todo
- [ ] todo
- [ ] todo

## ETC

 

 

---

📌 깃허브에서 이슈 등록하는 방법

프로젝트 레포지토리에서 Settings - General - Featuers에서 Set up Templates

 

 

Custom templates 선택

 

 

Preview and edit 클릭 후 나오는 연필 모양 아이콘 선택 

 

 

위에 작성해둔 양식 복사해서 템플릿 작성

 

 

 

 

Propose changes 누르고 커밋까지 해줘야 이슈 등록 완료

 

 

 

 

---

📌 이슈 등록하기 

 

 

 

 

 

 

 

 

커밋 할 때 해당 이슈번호 [#1] 를 커밋 메시지에 사용해주면 깃허브에서 커밋 확인 시 해당 이슈를 볼 수 있다.  

 

 

커밋

 

 

 

 

이슈를 종료할 때 Close with comment 버튼을 눌러준다. 

다시 이슈를 열고 싶다면 Reopne 버튼을 누르면 된다. 

 

커밋 메시지에서 아래 키워드들과 함께 커밋 시 이슈 종료 가능

ex) close : #1

 

close

closes

closed

fix

fixes

fixed

resolve

resolves

resolved