레포지토리 별 Issue(Feature, Bug report 등), PR template 추가 및 적용

KMU-dyheo commented 1 year ago

[x] Issue 작성 규칙
[x] PR 템플릿 제안
[x] Commit 메시지 규칙

Choi-Jiwon-38 commented 1 year ago

프로젝트 구성원 간 협업

GitHub Commit Convention

태그 이름	설명
Feat	새로운 기능을 추가
Fix	버그 수정
Design	User Interface 디자인 변경(CSS 등)
Refactor	코드 리팩토링
Style	코드 포매팅 변경
Docs	문서 수정
Test	테스트 관련 코드 추가
Chore	빌드 업부, 패키지 매니저 관련 수정
Rename	파일, 디렉토리 명칭 수정 및 이동 작업
Remove	파일 삭제 작업

태그: 제목 '태그:(space)제목' 의 형태로 작성한다. → ex) Feat: 회원 가입 기능 구현

위 내용을 참고하여 아래처럼 프로젝트 커밋 메세지 구조를 정립한다.

제목 (Type: Subject)

본문 (Body)

꼬리말 (Footer)

제목, 본문, 꼬리말은 한 줄 띄어씀으로 구분한다.
제목은 50글자 이내로 작성하며 첫 글자는 대문자로 작성한다(fix → X / Fix → O).
제목은 간결하고 요점적인 개조식 구문으로 작성, 상세한 기술이 필요한 경우 본문(Body)을 이용
꼬리말(Footer)는 issue tracker ID를 명시하고 싶은 경우에만 선택적으로 작성한다(참고 사이트).

Choi-Jiwon-38 commented 1 year ago

Issue 작성 규칙도 23. 10. 12 수업 이후에 정립된다면 Issue Template을 사용하는 방법을 고려하면 좋을 것 같습니다.

Issue Template을 사용할 경우, 위 사진처럼 상황에 적절한 획일화된 Issue를 생성할 수 있습니다(관련 GitHub Docs).

Choi-Jiwon-38 commented 1 year ago

Issue 크게 2가지로 구분하며 필요에 따라 추가할 수 있도록 합니다.

Feature Request(기능 요청 Issue)
Bug Report(버그 보고 Issue)

Issue template의 경우에는 GitHub에서 beta 버전으로 열어둔 issue forms를 사용하는 것도 좋을 거 같습니다(참고 사이트).

기능 요청 Issue 템플릿으로 아래 markdown 양식을 제시합니다.

---
name: "Feature request (기능 요청)"
about: 프로젝트에 필요한 기능에 대한 아이디어를 제시합니다.
title: ''
labels: enhancement
assignees: ''

---

**Main idea**
추가하거나 개선하고자 하는 사항에 대하여 설명해주세요.

**Alternative ideas**
Main idea에 대한 대안 아이디어나 방향이 있는 경우에 설명해주세요.

**Anything else?**
기능 요청에 대한 부가 설명이 필요한 경우에 작성해주세요.

버그 보고 Issue 템플릿으로 아래 markdown 양식을 제시합니다.

---
name: "Bug report (버그 보고)"
about: 프로젝트 진행 과정에서 발생한 버그를 보고합니다.
title: ''
labels: bug
assignees: ''

---

**Describe the bug**
버그(문제 상황)에 대한 설명을 간결하게 작성해주세요.
(문제 상황 이해를 돕기 이한 스크린샷 및 영상 첨부도 가능합니다.)

**To Reproduce**
문제 상황을 재현하는 방법에 대하여 작성해주세요.
Ex)
1. `Start iOS Simulator` 버튼을 클릭한다.
2. `Home` 페이지로 이동하여...

**Anything else?**
기능 요청에 대한 부가 설명이 필요한 경우에 작성해주세요.

Choi-Jiwon-38 commented 1 year ago

PR template의 참고용으로 Angular 팀에서 사용하는 template을 사용하면 좋을 거 같습니다. Angular - PULL_REQUEST_TEMPLATE.md

Choi-Jiwon-38 commented 1 year ago

관련 내용은 timebank-2023-docs 레포지토리의 Wiki에 정리해두었으며, 해당 이슈는 리뷰 중으로 상태 변경하였습니다.

https://github.com/kookmin-sw/timebank-2023-docs/wiki/Project-Conventions

KMU-dyheo commented 1 year ago

Good work! 오늘 논의 제안한 내용 논의하도록 합니다.

kookmin-sw / timebank-2023-docs

레포지토리 별 Issue(Feature, Bug report 등), PR template 추가 및 적용 #10