Clarify commit suggestions

Abierto
#39 3 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
Medio día
Aptitud para principiantes
45/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
git

Línea de trabajo

Comienza con la sección enlazada «Formatting and Naming Conventions» de Collaborative Distributed Science Guide y revisa sus indicaciones actuales sobre los commits. Se considera terminado cuando la sección explica claramente el propósito de los mensajes de commit, la legibilidad y la comprensión del trabajo realizado, incluye enlaces a buenas prácticas de commits legibles por máquinas y enfatiza por qué se realizan los cambios.

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

Descripción

design documentation help wanted question

The Formatting and Naming Conventions section could use a re-visit. I think we need to elevate the commit portion, but also make it more in-line with practice. We should summarize the purpose of commit messages, highlighting important aspects of readability and understanding processes done. Then also link to good practices for, e.g., machine-readability and such, but the ultimate goal of understandable commits (why is this change happening) needs to be expressed clearly.

Lenguaje dominante
Python
Estrellas
1
Forks
1
Merge medio
6 d 1 h
PR fusionados (30 d)
1

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 Imageomics/Collaborative-distributed-science-guide

Todos los issues de Imageomics/Collaborative-distributed-science-guide

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.