chore: writeGitignoreHint comment cites a planning id and explains why

Abierto Apto para principiantes
#380 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
1/5
Tiempo estimado
Menos de una hora
Aptitud para principiantes
88/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
go
Área
cli

Línea de trabajo

Abre internal/cli/init.go y busca el comentario de documentación de writeGitignoreHint. Reescríbelo para describir el archivo .codegraph/.gitignore que escribe, e incluye que ignora todo lo que hay en ese directorio y que se abre sin seguir un enlace simbólico; elimina el ID de planificación. El trabajo estará listo cuando el comentario indique esos detalles de comportamiento y esa restricción sin explicar el motivo.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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

Lenguaje dominante
Go
Estrellas
0
Forks
0
Merge medio
7 h 42 min
PR fusionados (30 d)
111

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de seanb4t/codegraph-go

Todos los issues de seanb4t/codegraph-go

Issues similares

Más issues de Go

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.