Compartir a través de

Contribución a la documentación de PowerShell

Gracias por su apoyo a PowerShell.

La Guía del colaborador es una colección de artículos que describen las herramientas y los procesos que usamos para crear documentación en Microsoft. Algunas de estas guías cubren información común a cualquier conjunto de documentación publicado en learn.microsoft.com. Otras guías son específicas de cómo se escribe documentación para PowerShell.

Los artículos comunes están disponibles en nuestra Guía centralizada de colaboradores. Las guías específicas de PowerShell están disponibles aquí.

Formas de contribuir

Hay dos maneras de contribuir. Ambas contribuciones son valiosas para nosotros.

  • Presentar problemas nos ayuda a identificar problemas y brechas en nuestra documentación. A veces, los problemas son difíciles de resolver, requiriendo más investigación y estudio. El proceso de problema nos permite tener una conversación sobre el problema y desarrollar una resolución satisfactoria.

  • Enviar un pull request para agregar o cambiar contenido es un proceso más complejo. En la siguiente información se describen las herramientas, los procesos y los estándares para enviar contenido a la documentación.

Preparación para realizar una contribución

La contribución a la documentación requiere una cuenta de GitHub. Use la siguiente lista de comprobación para instalar y configurar las herramientas que necesita para realizar contribuciones.

  1. Registro en GitHub
  2. Instalación de las herramientas de Git y Markdown
  3. Instalación del paquete de creación de Docs
  4. Instalación de Posh-Git : no es necesario, pero se recomienda
  5. Configuración de un repositorio git local
  6. Revisión de los aspectos básicos de Git y GitHub

Introducción a la escritura en Docs

Hay dos maneras de contribuir a los cambios en la documentación:

  1. Modificaciones rápidas en documentos existentes : correcciones menores, corrección de errores tipográficos o pequeñas adiciones
  2. Flujo de trabajo completo de GitHub para documentos : cambios grandes, varias versiones, agregar o cambiar imágenes, o contribuir a nuevos artículos

Además, lea la sección Aspectos básicos de escritura de la Guía centralizada del colaborador. Otro excelente recurso es la Guía de estilo de escritura de Microsoft.

Las correcciones menores o aclaraciones de documentación y ejemplos de código en repositorios públicos están cubiertos por los términos de uso de learn.microsoft.com.

Use el flujo de trabajo completo de GitHub cuando realice cambios significativos. Si no es empleado de Microsoft, nuestro sistema de validación agrega un comentario a la solicitud pidiéndole que firme en línea el Contrato de Licencias de Contribución (CLA). Debe completar este paso para poder revisar o aceptar la solicitud de incorporación de cambios. Firmar el CLA solo es necesario la primera vez que envías un PR en el repositorio. Es posible que se le pida que firme la CLA cada vez que contribuya a un nuevo repositorio.

Código de conducta

Todos los repositorios que publican en Microsoft Learn se adhieren al código de conducta de código abierto de Microsoft o al código de conducta de .NET Foundation. Para obtener más información, consulte las preguntas más frecuentes sobre el código de conducta.

Pasos siguientes

En los siguientes artículos se trata información específica de la documentación de PowerShell. Cuando haya superposición con las instrucciones de la Guía del colaborador centralizado, se indica cómo difieren esas reglas para el contenido de PowerShell.

Consulte los documentos siguientes:

Recursos adicionales