Cómo enviar solicitudes de incorporación de cambios

Para realizar cambios en el contenido, envíe una solicitud de incorporación de cambios (PR) desde la bifurcación. Se debe revisar una solicitud de incorporación de cambios para poder combinarla. Para obtener los mejores resultados, revise la lista de comprobación editorial antes de enviar la solicitud de incorporación de cambios.

Uso de ramas de Git

La rama predeterminada para PowerShell-Docs es la main rama. Los cambios realizados en las ramas de trabajo se combinan en la main rama antes de su publicación. La rama main se fusiona con la rama live de lunes a viernes a las 3:00 p. m. (hora del Pacífico). La live rama contiene el contenido que se publica en learn.microsoft.com.

Antes de iniciar los cambios, cree una rama de trabajo en la copia local del repositorio de PowerShell-Docs. Al trabajar localmente, asegúrese de sincronizar el repositorio local antes de crear la rama de trabajo. La rama de trabajo debe crearse a partir de una copia up-to-date de la main rama.

Todas las solicitudes de incorporación de cambios deben tener como destino la rama main. No envíe cambios a la rama live. Los cambios realizados en la main rama se combinan en live, sobrescribiendo cualquier cambio realizado en live.

Hacer que el proceso de solicitud de incorporación de cambios funcione mejor para todos los usuarios

Cuanto más sencilla y centrada puedas hacer tu PR, más rápido se podrá revisar y fusionar.

Evitar solicitudes de incorporación de cambios que actualicen un gran número de archivos o contengan cambios no relacionados

Evite crear solicitudes de incorporación de cambios que contengan cambios no relacionados. Separe las actualizaciones secundarias de los artículos existentes de los nuevos artículos o reescrituras principales. Trabaje con estos cambios en ramas de trabajo independientes.

Los cambios masivos crean solicitudes de incorporación de cambios con un gran número de archivos modificados. Limite las solicitudes de incorporación de cambios a un máximo de 50 archivos modificados. Las solicitudes de incorporación de cambios grandes son difíciles de revisar y son más propensas a contener errores.

Cambiar el nombre o eliminar archivos

Debe haber un problema asociado con el pull request cuando renombres o elimines archivos. Este problema debe discutir la necesidad de cambiar el nombre o eliminar los archivos.

Evite mezclar adiciones de contenido o cambios con el cambio de nombre de archivo y eliminaciones. Cualquier archivo que cambie el nombre o elimine debe agregarse al archivo de redireccionamiento adecuado. Cuando sea posible, actualice los archivos que se vinculan al contenido cambiado o eliminado, incluidos los archivos TOC.

Evitar la edición de archivos de configuración del repositorio

Evite modificar los archivos de configuración del repositorio. Limite los cambios siempre que sea posible a los archivos de contenido de Markdown y a los archivos de imagen auxiliares necesarios para el contenido.

Las modificaciones incorrectas en los archivos de configuración del repositorio pueden interrumpir la compilación, introducir vulnerabilidades o problemas de accesibilidad, o infringir los estándares de la organización. Los archivos de configuración del repositorio son archivos que coinciden con uno o varios de estos patrones:

• *.yml
• .github/**
• .localization-config
• .openpublishing*
• LICENSE*
• reference/docfx.json
• reference/mapping/**
• tests/**
• ThirdPartyNotices
• tools/**

Para la seguridad y protección, no cambie estos archivos. Si cree que uno de estos archivos debe cambiarse, informe un problema. Después de que los mantenedores evalúen el problema, realizarán los cambios adecuados.

Uso de la plantilla de solicitud de incorporación de cambios

Al crear un pull request, se inserta automáticamente una plantilla en el cuerpo del pull request. Tiene este aspecto:

# PR Summary

<!--
    Delete this comment block and summarize your changes and list
    related issues here. For example:

    This changes fixes problem X in the documentation for Y.

    - Fixes #1234
    - Resolves #1235
-->

## PR Checklist

<!--
    These items are mandatory. For your PR to be reviewed and merged,
    ensure you have followed these steps. As you complete the steps,
    check each box by replacing the space between the brackets with an
    x or by clicking on the box in the UI after your PR is submitted.
-->

- [ ] **Descriptive Title:** This PR's title is a synopsis of the changes it proposes.
- [ ] **Summary:** This PR's summary describes the scope and intent of the change.
- [ ] **Contributor's Guide:** I have read the [contributors guide][contrib].
- [ ] **Style:** This PR adheres to the [style guide][style].

<!--
    If your PR is a work in progress, please mark it as a draft or
    prefix it with "(WIP)" or "WIP:"

    This helps us understand whether or not your PR is ready to review.
-->

[contrib]: /powershell/scripting/community/contributing/overview
[style]: /powershell/scripting/community/contributing/powershell-style-guide

En la sección "Resumen de PR", escriba un resumen conciso de los cambios y enumere los problemas relacionados por su número de incidencia, como #1234. Si la solicitud de incorporación de cambios corrige o resuelve el problema, use la característica de cierre automático de GitHub para que el problema se cierre automáticamente cuando se combine la solicitud de incorporación de cambios.

Revise los elementos de la sección "Lista de comprobación de PR" y márquelos a medida que complete cada uno. Debes seguir las instrucciones y comprobar cada elemento para que el equipo apruebe tu PR.

Si la propuesta de cambios es un trabajo en curso, establézcala en modo borrador o prefigura el título de la propuesta de cambios con WIP.

Comentario de expectativas

Después de enviar tu PR, un bot dejará un comentario al respecto. El comentario proporciona recursos y establece expectativas para el resto del proceso. Es posible que actualicemos este comentario periódicamente, por lo que siempre revise el comentario, incluso si esto no es su primera contribución.

Servicio de validación de pr de Docs

El servicio de validación de PR de Docs es una aplicación de GitHub que ejecuta reglas de validación sobre tus cambios. Debe corregir los errores o advertencias notificados por el servicio de validación.

En los pasos siguientes se describe el comportamiento de validación:

1. Envía una solicitud de incorporación de cambios.

2. En el comentario de GitHub que indica el estado de las "comprobaciones" habilitadas en el repositorio. En este ejemplo, hay dos comprobaciones habilitadas, "Confirmar validación" y "OpenPublishing.Build":

   

   La compilación puede pasar incluso si falla la validación del commit.

3. Seleccione Detalles para obtener más información. En la página Detalles se muestran todas las comprobaciones de validación con errores e incluye información sobre cómo corregir los problemas.

4. Cuando la validación se realiza correctamente, se agrega el siguiente comentario al PR:

   

Nota:

Si es colaborador externo (no empleado de Microsoft), no tiene acceso a los informes de compilación detallados ni a los vínculos de vista previa.

Cuando se revisa la solicitud de incorporación de cambios, es posible que se le pida que realice cambios o corrija los mensajes de advertencia sobre validación. El equipo de PowerShell-Docs puede ayudarle a comprender los errores de validación y los requisitos editoriales.

Acciones de GitHub

Varias acciones de GitHub diferentes se ejecutan en los cambios para validar y proporcionar contexto para usted y los revisores.

Comprobación de la lista de comprobación

Si la solicitud de incorporación de cambios no está en modo borrador y no tiene WIPel prefijo , una acción de GitHub inspecciona la solicitud de incorporación de cambios para comprobar que ha seleccionado todos los elementos de la lista de comprobación de la plantilla de solicitud de incorporación de cambios. Los responsables no revisarán ni fusionarán tu PR hasta que completes la lista de comprobación. Los elementos de la lista de comprobación son obligatorios.

Comprobación de autorización

Si su solicitud de incorporación de cambios está dirigida a la rama live o modifica los archivos de configuración del repositorio, una acción de GitHub verifica sus permisos para asegurar que usted está autorizado para enviar esos cambios.

Solo los administradores del repositorio están autorizados para dirigirse a la live rama o modificar los archivos de configuración del repositorio.

Informes de cambios de contenido versionados

Si la solicitud de incorporación de cambios agrega, quita o modifica cualquier contenido con versiones, una acción de GitHub analiza los cambios y escribe un informe que resume los tipos de cambios realizados en el contenido con versiones.

Este informe puede mostrar si hay otras versiones de los archivos que necesita actualizar en esta solicitud de incorporación de cambios.

Para buscar el informe de contenido versionado de tu solicitud de extracción:

1. Seleccione la pestaña "Comprobaciones" en la página de solicitud de incorporación de cambios.
2. Seleccione la tarea "Informes" de la lista de tareas.
3. Seleccione "..." botón en la parte superior derecha.
4. Seleccione "Ver resumen del trabajo".

Pasos siguientes

guía de estilo dePowerShell-Docs

Recursos adicionales

Cómo gestionamos las solicitudes de incorporación de cambios