git / git/git.github.io

Update documentation and docstrings in `CONTRIBUTING.md`

Abierto
#864 2 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Lenguaje dominante
CSS
Estrellas
373
Forks
325
Merge medio
4 d 18 h
PR fusionados (30 d)
1

Descripción

In CONTRIBUTING.md, an issue was identified regarding: Repository lacks a CONTRIBUTING.md guide for open-source collaboration.

  1. Current behavior: The codebase currently exhibits Repository lacks a CONTRIBUTING .
  2. Expected behavior: The code should execute reliably, validate bounds/inputs, and adhere to repository conventions.
  3. Problem justification: Leaving this unaddressed risks unexpected runtime crashes, degraded maintainability, or API contract violations.

cc @sivaraam

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

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.

Línea de trabajo

Comienza leyendo CONTRIBUTING.md y compara su contenido con la necesidad, indicada en el issue, de una guía de colaboración de código abierto. Aclara qué instrucciones y docstrings faltan; después, actualiza el archivo y verifica que proporcione un flujo de trabajo de contribución completo y coherente con las convenciones del repositorio.

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

Evaluación

Stack tecnológico
markdown
Área
documentation
Tipo de issue
Documentación
Dificultad
2/5
Tiempo estimado
1-3 horas
Estado de actividad
Activo
Claridad
Necesita aclaración
Aptitud para principiantes
45/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.