DaleStudy / DaleStudy/github

refactor: 패턴 분석 코멘트도 학습 현황처럼 upsert(PATCH) 방식으로 전환

オープン
#23 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

主要言語
JavaScript
スター
2
フォーク
2
PR マージ指標
30日以内にマージされた PR はありません

説明

배경

현재 패턴 분석 코멘트 (handlers/tag-patterns.js)는 매 push마다
기존 봇 코멘트를 전부 DELETE한 뒤 새로 POST하는 방식으로 갱신됨.

반면 학습 현황 코멘트 (utils/learningComment.js upsertLearningStatusComment)는
marker로 기존 코멘트를 찾아 PATCH로 body만 업데이트하는 upsert 패턴을 사용 중.

#20 에서 synchronize 최적화가 들어가면서,
변경된 파일에 한정해서는 "기존 코멘트를 edit"하는 형태가 자연스러움.

제안

변경된 파일의 패턴 분석 코멘트를 delete + repost → PATCH (edit in place) 로 전환.

  • PR review 코멘트도 PATCH /repos/{owner}/{repo}/pulls/comments/{comment_id}로 body 수정 가능
  • 파일명(comment.path)을 키로 기존 봇 코멘트를 찾아 upsert
    • 존재하면 PATCH body
    • 없으면 POST (신규 파일)

기대 효과

  • delete → create로 인한 알림/웹훅 노이즈 제거
  • 학습 현황 코멘트와 일관된 upsert 패턴으로 코드 단순화
  • 코멘트 ID가 push 간에 안정적으로 유지됨 (영구 링크 가능)

참고

  • Learning status 참고 구현: utils/learningComment.js:232 upsertLearningStatusComment
  • Pattern tag 현재 구현: handlers/tag-patterns.js:75, 104-154
  • 관련 PR: #20

Trade-off (작은 이슈, blocker 아님)

PATCH는 commit_id를 바꾸지 않으므로, 원본 커밋이 history에서 멀어지면
GitHub UI가 "Outdated" 배지를 붙일 수 있음. subject_type: "file" 코멘트는
라인 코멘트보다 덜 aggressive하게 처리되는 편이라 실사용상 큰 문제 없을 것으로 예상.

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

handlers/tag-patterns.js:75 と 104-154 から始め、次に utils/learningComment.js:232 のマーカー方式の実装と比較してください。既存のボットコメントが comment.path によってどのように識別されるかを追跡し、GitHub review-comment の PATCH および POST 呼び出しを確認してください。完了条件は、変更されたファイルのコメントが見つかった場合はその場で編集され、新しいファイルに対してのみ作成され、delete-and-repost の動作がないことです。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
javascript
領域
backend
issue の種類
リファクタリング
難易度
3/5
見積もり時間
1〜2日
活発さ
静か
明瞭さ
明確に書かれている
初心者へのやさしさ
76/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。