chore: writeGitignoreHint comment cites a planning id and explains why

Open Beginner friendly
#380 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
88/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
go
Domain
cli

Research direction

Open internal/cli/init.go and find the doc comment for writeGitignoreHint. Rewrite it to describe the .codegraph/.gitignore file it writes, including that it ignores everything in that directory and is opened without following a symbolic link; remove the planning id. Done when the comment states those behavior and constraint details without explaining the rationale.

Written by the indexing model from the issue text.

Description

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

Dominant language
Go
Stars
0
Forks
0
Avg merge
5h 16m
Merged PRs (30d)
107

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from seanb4t/codegraph-go

All issues in seanb4t/codegraph-go

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.