Documenting minimizing diffs for ease of review
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Python
- Estrellas
- 2.1k
- Forks
- 1k
- Merge medio
- 2 d 12 h
- PR fusionados (30 d)
- 12
Descripción
Suppose we have some lines that are close to 80 chars long
first text ... end first text.
second text ... end second text.
third text ... end third text.
and if the first line needs some sort of modification that would push it past 80 chars, we can either restructure the entire paragraph of raw rst so it looks tidier, but resulting in 4 lines of git diffs
first text plus some more ...
end first text. second text ...
end second text. third text ...
end third text.
or diffs can be minimized (but with an 'uglier' raw rst), such as like
first text plus some more ...
... end first text.
second text ... end second text.
third text ... end third text.
I think that for ease of reviewing, as well as to maintain a more useful git history, that the second is preferred in general but I haven't found it in the style guide, so maybe it can be added there if there's consensus on it?
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Lee la guía de estilo de documentación enlazada en el issue y revisa el debate existente sobre cómo minimizar los diffs. Añade orientación solo si el proyecto acuerda adoptar esta preferencia, con ejemplos que muestren el estilo de ajuste de línea recomendado; la guía de estilo debería documentar claramente la convención una vez terminado el trabajo.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- python
- Área
- documentation
- Tipo de issue
- Documentación
- Dificultad
- 2/5
- Tiempo estimado
- 1-3 horas
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 45/100