new feature(#598): Git Issue Template #693

kimdaeyeobbb · 2024-09-03T12:54:47Z

Related issue

#598

Result

Work list

1. 생성 및 병합한 issue template

docs

docs
- 단순 문서 작업을 docs에 배정 (md파일 수정)
- 참고 이슈

fix/bug

fix / bug
→ fix 통일
- 두개의 라벨링이 별도로 구분되어야할 필요성을 느끼지 못하였음
- 하기 git commit message convention
  (1️⃣ https://github.com/nhn/tui.chart/blob/main/docs/COMMIT_MESSAGE_CONVENTION.md
  2️⃣ https://www.conventionalcommits.org/en/v1.0.0-beta.2/,
  3️⃣ https://developers.google.com/blockly/guides/contribute/get-started/commits?hl=ko)
  에서도 fix는 bug fix를 위한것이라 되어있으므로 fix로 통일되는것이 필요해 보임
- 참고 이슈
  - git 연동이 안 된 프로젝트에서 무한로딩이 발생하는 증상 #520
  - [view] dev 모드 실행 시 에러 발생 #603
- 구성
  - related issue (text area)
  - 문제상황 (text area)
    - 텍스트
    - 이미지 캡쳐
  - 참고 (textarea)

test

test
- ~하는게 좋을 것 같다는 테스트에 관련한 것들은 discussion 혹은 suggestion라벨링을 하는것이 적절한 것으로 판단됨.
  ([view] e2e test 항목 추가(dev 모드 관련) #605)
- 하기 test 라벨링된 이슈들([test] #669 클러스터 클릭 관련 TC 테스트 코드 수정 #670, [view] e2e 테스트 - when click cluster 케이스 실패 관련 #669, feat: when pr, e2e test github actions ci #487, feat(view): ClusterGraph.utill test코드 작성 및 VerticalClusterList test 오류 수정 #467) 이 test 템플릿의 예시로서 적절하다는 판단이 들어 test템플릿 생성시 반영하였음

new feature

new feature

discussion/suggestion/question

discussion / suggestion / question
→ discussion 통일
- 중복되는 내용이 많기 때문에 별도로 이슈 템플릿을 생성해야할 필요성이 적게 느껴짐
- 또한 하나의 라벨을 정리함으로서 복잡성을 감소시키고자 하는 목적성도 있었음
  (라벨 정리는 영택님의 의견이 존중되어야할 듯함)
- question 라벨링 사용 0건
- suggestion 라벨링 빈도 매우 적음 (2년이내 2건)

실제 구성

2. 생성하지 않은 issue template

good first issue

본 기수의 프로젝트 진행시 최초 이슈생성 시점이 아닌 이슈 생성 이후 시점에서 라벨링 한다는 점에서 템플릿의 생성 대상에서 배제하였음

backlog

미사용 라벨이므로 템플릿 생성 X

knowledge

사용량이 적고, 본 링크(Issue #597)에 따르면 문서 정리 후 별도의 섹션으로 이동 (wiki화 혹은 코드화)이 되는 것을 주된 목적으로 하므로 템플릿 생성하기보다는 docs 혹은 discussion 에 해당하는 이슈 템플릿을 사용하는것이 적절하다고 판단하였음

analysis engine / view / vscode

해당 항목들은 영역 구분을 위한 것이기에 (라벨링의 2, 3번째 포지션) 템플릿을 미생성 하였음.
본 라벨들은 new feature, discussion 등의 기능 단위의 하위 포지션으로서 자리잡는것이 맞다고 생각하였음.

Discussion

docs로 할까 new feature로 할까 고민했습니다만 상기 내용에 의거해서 new feature로 선정하였습니다.
한번 훑어보시고 피드백 주세요 :)
상기 근거들은 히스토리 분석 후 진행하였으나 사견이 많이 반영되어있으니 의견 많이 제시해주시고 반박 환영해요!

This reverts commit 0edb8e8.

choisohyun

우와우 너무 좋은 것 같습니다!! 수고하셨습니다!👍👍👍

yoouyeon

이슈 템플릿 정말 필요하다고 생각하고 있었는데 덕분에 이슈 파악이 좀 더 쉬워질 것 같습니다! 수고하셨습니다!! 👍✨👍✨👍✨

yoouyeon · 2024-09-04T15:35:20Z

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,12 @@
+blank_issues_enabled: false


실제로 이슈 등록하는 화면을 보지 못해서 확실하지는 않지만
yml 형식으로 설정된 템플릿은 md 형식으로 설정된 템플릿하고는 다르게 이슈 작성 시에 템플릿 수정이 불가능한 것으로 알고 있습니다..! (제목을 조금 변경한다거나, 항목을 추가한다거나 하는 등)

이 설정을 보니 템플릿이 적용되지 않은 이슈는 생성이 불가능한 것 같은데, 만약에 정해진 템플릿'만' 사용해야 한다면 개인적으로는 규칙이 좀 강하게 적용되어 있는 느낌이 들기도 해서
이슈 템플릿을 md 형식으로 변경해서 정해진 템플릿 내에서 약간의 변경이 가능하게 하거나, 빈 이슈 생성이 가능하게 하는 옵션을 켜두는 것도 좋을 것 같아요!

실제로 이슈 등록하는 화면을 보지 못해서 확실하지는 않지만 yml 형식으로 설정된 템플릿은 md 형식으로 설정된 템플릿하고는 다르게 이슈 작성 시에 템플릿 수정이 불가능한 것으로 알고 있습니다..! (제목을 조금 변경한다거나, 항목을 추가한다거나 하는 등)

오!! yml과 md가 그런 차이가 있나요?? 몰랐군요

이 설정을 보니 템플릿이 적용되지 않은 이슈는 생성이 불가능한 것 같은데, 만약에 정해진 템플릿'만' 사용해야 한다면 개인적으로는 규칙이 좀 강하게 적용되어 있는 느낌이 들기도 해서 이슈 템플릿을 md 형식으로 변경해서 정해진 템플릿 내에서 약간의 변경이 가능하게 하거나, 빈 이슈 생성이 가능하게 하는 옵션을 켜두는 것도 좋을 것 같아요!

빈 이슈 옵션은 왠지 좋을 수도 있을 것 같습니다!

ytaek · 2024-09-04T16:29:59Z

.github/ISSUE_TEMPLATE/config.yml

+  - name: Discucssions
+    url: https://github.com/githru/githru-vscode-ext/discussions/new
+    about: 이곳에서 질문과 논의를 진행해주세요.


현재 discussion기능은 사용하고 있지 않아서 이 부분은 필요없을 것 같아요!

ytaek · 2024-09-04T16:30:53Z

.github/ISSUE_TEMPLATE/feature_request.yml

+name: feature request 🚀
+description: >-
+  추가하고 싶은 신규 기능에 대해 알려주세요.
+title: '[new feature]: '


title 기본 형식은 조금 생각해봐야겠네요.
label이 있으니 굳이 [new feature]라고 말머리를 또 붙일 필요가 있나 하는 생각도 드는군요 ㅎㅎ

ytaek · 2024-09-04T16:41:22Z

fix/bug

fix / bug
→ fix 통일

두개의 라벨링이 별도로 구분되어야할 필요성을 느끼지 못하였음

하기 git commit message convention
(1️⃣ https://github.com/nhn/tui.chart/blob/main/docs/COMMIT_MESSAGE_CONVENTION.md
2️⃣ https://www.conventionalcommits.org/en/v1.0.0-beta.2/,
3️⃣ https://developers.google.com/blockly/guides/contribute/get-started/commits?hl=ko)
에서도 fix는 bug fix를 위한것이라 되어있으므로 fix로 통일되는것이 필요해 보임

좋은 지적입니다! 둘이 같긴 하죠.
근데 issue를 리포팅할때는 bug라고 하는게 맞을 꺼 같고 (해결 안된 버그 리포팅),
PR을 올릴 때에는 fix 라고 하는게 맞을 것 같긴 하네요.

test

test

~하는게 좋을 것 같다는 테스트에 관련한 것들은 discussion 혹은 suggestion라벨링을 하는것이 적절한 것으로 판단됨.
([view] e2e test 항목 추가(dev 모드 관련) #605)

하기 test 라벨링된 이슈들([test] #669 클러스터 클릭 관련 TC 테스트 코드 수정 #670, [view] e2e 테스트 - when click cluster 케이스 실패 관련 #669, feat: when pr, e2e test github actions ci #487, feat(view): ClusterGraph.utill test코드 작성 및 VerticalClusterList test 오류 수정 #467) 이 test 템플릿의 예시로서 적절하다는 판단이 들어 test템플릿 생성시 반영하였음

리뷰 커멘트에서도 적었는데, 현재는 discussion 메뉴는 사용하지 않고 있구요.
대신에 issue에다가 discussion label을 달고 작성하고 있습니다.
그래서 test 랑은 조금 다르긴 합니다.

discussion/suggestion/question

discussion / suggestion / question
→ discussion 통일

중복되는 내용이 많기 때문에 별도로 이슈 템플릿을 생성해야할 필요성이 적게 느껴짐

또한 하나의 라벨을 정리함으로서 복잡성을 감소시키고자 하는 목적성도 있었음
(라벨 정리는 영택님의 의견이 존중되어야할 듯함)

question 라벨링 사용 0건

suggestion 라벨링 빈도 매우 적음 (2년이내 2건)

정리해주시는 것 너무 좋습니다 🥹🥹🥹🥹🥹
suggestion, question 은 말씀하신 대로 뭐 딱히 필요없을 수도 있겠네요 ㅎㅎ
discussion은 위에서 적힌 목적대로 사용하고 있습니다.

2. 생성하지 않은 issue template

good first issue

본 기수의 프로젝트 진행시 최초 이슈생성 시점이 아닌 이슈 생성 이후 시점에서 라벨링 한다는 점에서 템플릿의 생성 대상에서 배제하였음

👍

너무나도 훌륭한 PR 입니다 👍👍👍

말씀하신대로 논의할 부분들이 좀 있긴 한데,
이건은 이슈에서 discussion 을 달고 같이 얘기해봐도 좋을 것들이구요 (이런 용도의 discussion label 입니다 😄 )

label에 대한 정리는 여기서 정리가 마무리되더라도, 이슈에 한번 더 적어주시면 좋을 것 같습니다.
(discussion이 fix가 되면 knowledge label을 붙여서 기억할 만한 article로 tagging 하고 있습니다)

그리고, 올려주신 코드 내용은 template 내용인데, 실제로 생성되는 template 내용을 확인할 수 있으면
더 좋을 것 같습니다!!!

ytaek · 2024-09-27T05:21:48Z

@kimdaeyeobbb 님, 커멘트 확인해서 반영부탁드리겠습니다!

yuiseo

LGTM👏 너무 좋은 거 같아요!!

DaYoung-woo · 2024-10-07T01:24:17Z

LGTM✨ label을 정리해주셨군용👍

danny.yk and others added 3 commits September 3, 2024 21:33

docs: Git Issue template 적용

0edb8e8

Revert "docs: Git Issue template 적용"

2c9a436

This reverts commit 0edb8e8.

docs: Git Issue Template 적용

fd88d36

kimdaeyeobbb added the new feature label Sep 3, 2024

kimdaeyeobbb added this to the v0.7.2 milestone Sep 3, 2024

kimdaeyeobbb self-assigned this Sep 3, 2024

kimdaeyeobbb requested review from a team as code owners September 3, 2024 12:54

choisohyun previously approved these changes Sep 4, 2024

View reviewed changes

pcwadarong previously approved these changes Sep 4, 2024

View reviewed changes

yoouyeon previously approved these changes Sep 4, 2024

View reviewed changes

ytaek reviewed Sep 4, 2024

View reviewed changes

kimdaeyeobbb added 3 commits October 6, 2024 23:14

Merge remote-tracking branch 'upstream/main'

603467b

docs: 기본 템플릿 생성 가능하게 수정

90e3950

docs: discussion 항목 삭제

ca434a0

kimdaeyeobbb dismissed stale reviews from pcwadarong, yoouyeon, and choisohyun via ca434a0 October 6, 2024 23:37

seungineer approved these changes Oct 6, 2024

View reviewed changes

yuiseo approved these changes Oct 7, 2024

View reviewed changes

kimdaeyeobbb merged commit 6608496 into githru:main Oct 7, 2024
2 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

new feature(#598): Git Issue Template #693

new feature(#598): Git Issue Template #693

kimdaeyeobbb commented Sep 3, 2024 •

edited

Loading

choisohyun left a comment

yoouyeon left a comment

yoouyeon Sep 4, 2024

ytaek Sep 4, 2024

ytaek Sep 4, 2024

ytaek Sep 4, 2024

ytaek commented Sep 4, 2024

fix/bug

test

discussion/suggestion/question

2. 생성하지 않은 issue template

good first issue

ytaek commented Sep 27, 2024

yuiseo left a comment

DaYoung-woo commented Oct 7, 2024

new feature(#598): Git Issue Template #693

new feature(#598): Git Issue Template #693

Conversation

kimdaeyeobbb commented Sep 3, 2024 • edited Loading

Related issue

Result

Work list

1. 생성 및 병합한 issue template

docs

fix/bug

test

new feature

discussion/suggestion/question

실제 구성

2. 생성하지 않은 issue template

good first issue

backlog

knowledge

analysis engine / view / vscode

Discussion

choisohyun left a comment

Choose a reason for hiding this comment

yoouyeon left a comment

Choose a reason for hiding this comment

yoouyeon Sep 4, 2024

Choose a reason for hiding this comment

ytaek Sep 4, 2024

Choose a reason for hiding this comment

ytaek Sep 4, 2024

Choose a reason for hiding this comment

ytaek Sep 4, 2024

Choose a reason for hiding this comment

ytaek commented Sep 4, 2024

fix/bug

test

discussion/suggestion/question

2. 생성하지 않은 issue template

good first issue

ytaek commented Sep 27, 2024

yuiseo left a comment

Choose a reason for hiding this comment

DaYoung-woo commented Oct 7, 2024

kimdaeyeobbb commented Sep 3, 2024 •

edited

Loading