Update GH PR Guide Page

Abierto
#73 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
65/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Tranquilo
Stack tecnológico
git, github

Línea de trabajo

Comienza con la página enlazada GitHub PR Guide y compara sus dos primeras secciones con las actualizaciones recientes de GitHub, centrándote en las capturas de pantalla, la selección de revisores y las protecciones de ramas. Añade la sección solicitada “4. Merge Your Pull Request” usando las indicaciones proporcionadas sobre squash-merge y branch-scoping; el trabajo estará terminado cuando esas actualizaciones y la nueva sección se reflejen correctamente en la página de la guía.

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

Descripción

documentation enhancement

Further updates to the first two sections of the GitHub PR Guide are still needed to align with GitHub's recent updates, though this is more about updating screenshots than actual content. There are a few more features that may be worth highlighting, but a major overhaul is not required.

One more thing to note in that section is actually picking a reviewer or reviewers, i.e., that it should be those that are most familiar with the content after the author and that they must have write access to the repo for it to satisfy branch protections (arguably, this should be covered by most familiar with content).

Additionally (pulling from a discussion in a private repo), let's make a section: "4. Merge Your Pull Request" which will include information about the merging options.

Basics on Squash Merge from @johnbradley's original Two Repo problem draft:

  • Often there are many messy commits that should be reduced to meaningful commits.
  • One easy way to reduce the messy commits into a single commit is using a Squash and merge Pull Request.

Paired with the scope note mentioned in my comment:

We should be sure to emphasize the fact that once a branch is squash merged into main, it can't continue to be used for development, so they should be scoped. Also, that they should be scoped so the squash merge makes sense and can still be used to tell the story (for instance, one feature change and the associated adjustments to tests).

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.