Registros de cambios en las solicitudes de extracción
Esta página fue traducida por PageTurner AI (beta). No está respaldada oficialmente por el proyecto. ¿Encontraste un error? Reportar problema →
La entrada del registro de cambios en tu solicitud de extracción sirve como un resumen (tl;dr) de tus cambios: ¿afectan a Android?, ¿son cambios que rompen compatibilidad?, ¿se añade algo nuevo?
Proporcionar un registro de cambios con formato estandarizado ayuda a los coordinadores de lanzamientos a redactar las notas de versión. Por favor, incluye un registro de cambios como parte de la descripción de tu solicitud de extracción. Esta descripción se usará como mensaje de commit si la solicitud se fusiona.
Formato
Una entrada del registro de cambios sigue este formato:
## Changelog:
[Category] [Type] - Message
El campo "Categoría" puede ser uno de:
-
Android, para cambios que afectan Android.
-
iOS, para cambios que afectan iOS.
-
General, para cambios que no encajan en otras categorías.
-
Internal, para cambios irrelevantes para desarrolladores que consulten las notas de versión.
El campo "Tipo" puede ser uno de:
-
Breaking, para cambios que rompen compatibilidad.
-
Added, para nuevas funcionalidades.
-
Changed, para modificaciones en funcionalidades existentes.
-
Deprecated, para características que se eliminarán próximamente.
-
Removed, para características ya eliminadas.
-
Fixed, para corrección de errores.
-
Security, en caso de vulnerabilidades.
Finalmente, el campo "Mensaje" responde al "qué y por qué" a nivel funcional. Úsalo para informar brevemente a los usuarios de React Native sobre cambios relevantes.
Para más detalles, consulta ¿Cómo crear un buen registro de cambios? y ¿Por qué mantener un registro de cambios?
Ejemplos
-
[General] [Added] - Add snapToOffsets prop to ScrollView component -
[General] [Fixed] - Fix various issues in snapToInterval on ScrollView component -
[iOS] [Fixed] - Fix crash in RCTImagePicker
Preguntas frecuentes
¿Qué pasa si mi solicitud contiene cambios para Android y JavaScript?
Usa la categoría Android.
¿Qué pasa si mi solicitud contiene cambios para Android e iOS?
Usa la categoría General si los cambios se envían en una misma solicitud.
¿Qué pasa si mi solicitud contiene cambios para Android, iOS y JavaScript?
Usa la categoría General si los cambios se envían en una misma solicitud.
¿Qué pasa si...?
Cualquier entrada en el registro es mejor que ninguna. Si dudas sobre la categoría correcta, usa el campo "Mensaje" para describir tu cambio de forma concisa.
Estas entradas son procesadas por el script @rnx-kit/rn-changelog-generator para generar un borrador, que luego edita el coordinador del lanzamiento.
Tus notas se usarán para ubicar tu cambio en el lugar correcto de las notas de versión finales.