Add pre-merge checklist in core developer guide

Abierto Apto para principiantes
  • ¿Algo no está bien?
#653 0 comentarios 1 reacción 0 asignados Ver en GitHub

Los mantenedores suelen responder en 2 días

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
1/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
62/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Estancado
Área
documentation

Línea de trabajo

Edita la sección sobre revisión de docs/developers/coredev/core_dev_guide.md, enlazada en el issue. Empieza leyendo esa sección y ajusta la lista de comprobación propuesta antes del merge a las indicaciones existentes; decide si describir el paso de las comprobaciones finales y su función en la automatización. Se considerará terminado cuando la guía cubra las comprobaciones enumeradas y la diferencia entre las comprobaciones finales y un período de espera antes del merge.

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

Descripción

Our core developer guide has a section on reviewing, but it is missing essential information about merge-time conventions/etiquette. Especially now that @willingc is advocating for getting rid of the "ready to merge" wait period, I think it's important to add to the guide everything that needs to happen before a PR is merged:

  • check the type label type (feature, label, performance, etc)
  • check the milestone
  • check discussion comments are addressed or an issue is made to keep track of remaining to-dos
  • make sure the title still reflects the state/purpose of the PR
  • make sure the description reflects the current state/purpose of the PR (it's encouraged to leave the original description underneath under the heading "original description", since it provides the context for the subsequent discussion on the PR itself. However, the description becomes the commit message, so it should reflect the status of the PR at the time of merging.)

Some of those checks should ideally be automated, so we could perhaps rename "ready to merge" to "final checks" and keep it only for the automations, not for the wait period.

Lenguaje dominante
Makefile
Estrellas
13
Forks
71
Merge medio
3 d 8 h
PR fusionados (30 d)
31

Preparar el entorno

  • Sin Dockerfile ni archivo de Docker Compose
  • Tiene una plantilla de pull request
  • Sin guía de contribución

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 napari/docs

Todos los issues de napari/docs

Issues similares

Más issues de Documentation

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.