chore: writeGitignoreHint comment cites a planning id and explains why

オープン 初心者向け
#380 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

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

評価

難易度
1/5
見積もり時間
1時間未満
初心者へのやさしさ
88/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
go
領域
cli

調査の方向性

internal/cli/init.goを開き、writeGitignoreHintのドキュメンテーションコメントを探します。書き込むファイル.codegraph/.gitignoreについて説明するよう書き換え、そのディレクトリ内のすべてを無視することと、シンボリックリンクをたどらずに開くことを含めます。計画IDを削除します。コメントが、理由を説明せずにこれらの動作と制約の詳細を記述していれば完了です。

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

説明

chore needs-triage
What kind of chore?

Repository housekeeping

What needs doing?

The doc comment of writeGitignoreHint in internal/cli/init.go ends with "(A4, executor's discretion)". It also explains why the function writes .codegraph/.gitignore and not the root .gitignore. The repository rule for comments says a comment states what the code does and the constraint an editor can break. Planning ids and reasons go in the commit, the PR or docs/.

Rewrite the comment to say what the function writes: a .gitignore inside .codegraph/ that ignores everything in that directory, opened without following a symbolic link. Delete the planning id.

Why now?

Tidiness. The suite review of #378 found it next to the changed line. The PR left it alone because it was outside that diff.

Does this touch anything load-bearing?
  • None of these
Before submitting
  • I searched existing issues and this is not a duplicate

🤖 Generated with Claude Code

主要言語
Go
スター
0
フォーク
0
平均マージ
7時間 42分
マージ済み PR(30日)
111

環境構築

はじめの一歩

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

seanb4t/codegraph-go のほかの issue

seanb4t/codegraph-go の issue をすべて見る

似ている issue

Go の issue をもっと見る

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

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