Guía para colaboradores de Microsoft Docs: información generalMicrosoft Docs contributor guide overview

Le damos la bienvenida a la guía para colaboradores de docs.microsoft.com (Docs).Welcome to the docs.microsoft.com (Docs) Contributor Guide!

Algunos de nuestros conjuntos de documentación son de código abierto y están hospedados en GitHub.Several of our documentation sets are open source, hosted on GitHub. Cada vez son más los equipos en Microsoft que están adoptando este modelo.More teams at Microsoft are adopting this model all the time. Incluso los conjuntos de documentos que no son completamente de código abierto tienen repositorios públicos en los que se pueden realizar solicitudes de incorporación de cambios.Even document sets that are not completely open source have public-facing repos where you are invited to make pull requests. De este modo, se optimiza y se mejora la comunicación entre los ingenieros de productos, los equipos de contenido y nuestros clientes.It streamlines and improves communication between the product engineers, the content teams, and our customers. Al trabajar a la vista, se puede disfrutar de diversas ventajas:Working in the open provides several advantages:

  • Los repositorios de código abierto se planean a la vista para obtener comentarios sobre qué documentos son más necesarios.Open source repos plan in the open to get feedback on what docs are most needed.
  • Los repositorios de código abierto se revisan a la vista para publicar el contenido más útil en la primera versión.Open source repos review in the open to publish the most helpful content on our first release.
  • Los repositorios de código abierto se actualizan a la vista para facilitar la mejora continua de los contenidos.Open source repos update in the open to make it easier to continuously improve the content.

La experiencia del usuario de docs.microsoft.com integra directamente flujos de trabajo de GitHub para que resulte todavía más fácil.The user experience on docs.microsoft.com integrates GitHub workflows directly to make it even easier. Para comenzar, edite el documento que está viendo.Start by editing the document you are viewing. También puede revisar nuevos temas o notificar problemas de calidad.Or, help by reviewing new topics, or create quality issues.

Importante

Todos los repositorios que publican en docs.microsoft.com han adoptado el Código de conducta de código abierto de Microsoft o el Código de conducta de .NET Foundation.All repositories that publish to docs.microsoft.com have adopted the Microsoft Open Source Code of Conduct or the .NET Foundation Code of Conduct. Para obtener más información, vea las preguntas más frecuentes del Código de conducta.For more information, see the Code of Conduct FAQ. O póngase en contacto con opencode@microsoft.com o conduct@dotnetfoundation.org para enviar sus preguntas o comentarios.Or contact opencode@microsoft.com, or conduct@dotnetfoundation.org with any questions or comments.

Las correcciones menores o aclaraciones de la documentación y los ejemplos de código de los repositorios públicos se rigen por los Términos de uso del sitio docs.microsoft.com.Minor corrections or clarifications to documentation and code examples in public repositories are covered by the docs.microsoft.com Terms of Use. Los cambios importantes o nuevos generan un comentario en la solicitud de incorporación de cambios que le pide que acepte el contrato de licencia de colaboración (CLA, por sus siglas en inglés) si no es un empleado de Microsoft.New or significant changes generate a comment in the pull request, asking you to submit an online Contribution License Agreement (CLA) if you are not an employee of Microsoft. Necesitamos que rellene el formulario en línea para revisar o aceptar su solicitud de incorporación de cambios.We need you to complete the online form before we can review or accept your pull request.

Ediciones rápidas en documentos existentesQuick edits to existing documents

Las ediciones rápidas optimizan el proceso de notificación y corrección de pequeños errores y omisiones en los documentos.Quick edits streamline the process to report and fix small errors and omissions in documents. A pesar de todos los esfuerzos, en ocasiones los documentos que publicamos contienen algunos errores gramaticales y erratas.Despite all efforts, small grammar and spelling errors do make their way into our published documents. Aunque puede notificar un problema para informar sobre estos errores, es más rápido y fácil crear una solicitud de incorporación de cambios para corregirlo.While you can create issues to report mistakes, it's faster and easier to create a pull request (PR) to fix the issue. Prácticamente en todos los artículos aparece un botón para editar, como se muestra en la imagen siguiente.Almost every article displays an edit button as shown in the following figure. Al hacer clic en el botón Editar, se le redirige al archivo de código fuente en GitHub.Clicking the Edit (or equivalent localized) button takes you to the source file on GitHub.

Ubicación del vínculo Editar

Después, haga clic en el icono de lápiz para editar el artículo, como se muestra en la imagen siguiente.Next, click the pencil icon, shown in the following figure to edit the article.

Ubicación del icono de lápiz

Nota

Si el icono de lápiz aparece atenuado, debe iniciar sesión en su cuenta de GitHub o crear una cuenta.If the pencil icon is grayed out, you need to login to your GitHub account, or create a new account.

Haga los cambios necesarios en el editor web.Make your changes in the web editor. Puede hacer clic en la pestaña Vista previa de los cambios para comprobar el formato del cambio.You can click the Preview changes tab to check the formatting of your change.

Una vez que haya realizado los cambios, desplácese hasta la parte inferior de la página.Once you have made your changes, scroll to the bottom of the page. Escriba un título y una descripción para la solicitud de incorporación de cambios y haga clic en Propose file change (Proponer cambio de archivo), como se muestra en la imagen siguiente:Enter a title and description for your PR and click Propose file change as shown in the following figure:

propuesta de cambio

Ahora que ha propuesto el cambio, es necesario solicitar a los propietarios del repositorio que "inserten" los cambios en su repositorio.Now that you've proposed your change, you need to ask the owners of the repository to "pull" your changes into their repository. Para ello, se usa algo denominado "solicitud de incorporación de cambios".This is done using something called a "pull request". Al hacer clic en Propose file change (Proponer cambio en archivo) en la ilustración anterior, se le dirigirá a una nueva página con un aspecto similar a la ilustración siguiente:When you clicked on Propose file change in the figure above, you should have been taken to a new page that looks like the following figure:

creación de solicitud de incorporación de cambios

Haga clic en Crear solicitud de incorporación de cambios, escriba un título (y opcionalmente una descripción) para la solicitud de incorporación de cambios y, de nuevo, haga clic en Crear solicitud de incorporación de cambios.Click Create pull request, enter a title (and optionally a description) for the pull request, and then click Create pull request again.

Eso es todo.That's it! Los miembros del equipo de contenido revisarán y combinarán la solicitud de incorporación de cambios.Content team members will review and merge your PR. Es probable que reciba un comentario en el que se le solicite algún cambio si ha realizado cambios grandes.You may get some feedback requesting changes if you made larger changes.

La interfaz de usuario de edición de GitHub responde a sus permisos en el repositorio.The GitHub editing UI responds to your permissions on the repository. Las imágenes anteriores hacen referencia a colaboradores que no tienen permisos de escritura en el repositorio de destino.The preceding images are accurate for contributors that do not have write permissions to the target repository. GitHub crea automáticamente una rama del repositorio de destino en su cuenta.GitHub automatically creates a fork of the target repository in your account. Si tiene acceso de escritura al repositorio de destino, GitHub crea en él una rama.If you have write access to the target repository, GitHub creates a new branch in the target repo. El nombre de la rama tiene el formato <GitHubId>-patch-n, en el que se usa su identificador de GitHub y un identificador numérico para la rama de la revisión.The branch name has the form <GitHubId>-patch-n using your GitHub ID, and a numeric identifier for the patch branch.

Usamos solicitudes de incorporación de cambios para todos los cambios, incluso en el caso de los colaboradores que tienen acceso de escritura.We use PRs for all changes, even for contributors that have write access. La mayoría de los repositorios tienen la rama master protegida para que las actualizaciones se tengan que enviar como solicitudes de incorporación de cambios.Most repositories have the master branch protected so that updates must be submitted as PRs.

La experiencia de edición en el explorador es mejor para los cambios menores o poco frecuentes.The in-browser editing experience is best for minor or infrequent changes. Si realiza grandes colaboraciones o usa características avanzadas de Git (como la administración de ramas o la resolución avanzada de conflictos de fusión), debe bifurcar el repositorio y trabajar localmente.If you make large contributions, or use advanced Git features (such as branch management or advanced merge conflict resolution), you need to fork the repo and work locally.

Nota

Si está habilitado, puede editar un artículo en cualquier idioma y, en función del tipo de edición, ocurrirá lo siguiente:If enabled, you can edit an article in any language and, based on the type of edit, the following will happen:

  1. cualquier cambio lingüístico aprobado ayudará también a mejorar nuestro motor de traducción automáticaany linguistic change that is approved, will also help improve our Machine Translation engine
  2. cualquier edición que modifique significativamente el contenido del artículo se administrará internamente para enviar un cambio al mismo artículo en inglés, de modo que se localice en todos los idiomas, si se aprueba.any edit that significantly modifies the content of the article, will be handled internally to submit a change to the same article in English, so that it will get localized in all languages, if approved. Por tanto, las sugerencias de mejora no solo incidirán de manera positiva en los artículos en su propio idioma, sino en todos los idiomas disponibles.So your suggested improvements will not only positively affect articles in your own language, but in all available languages.

Revisión de solicitudes de incorporación de cambios abiertasReview open PRs

Para leer nuevos temas antes de que se publiquen, consulte las solicitudes de incorporación de cambios abiertas.You can read new topics before they are published by checking the currently open PRs. Las revisiones siguen el proceso del flujo de GitHub.Reviews follow the GitHub flow process. Puede ver las actualizaciones propuestas o artículos nuevos en los repositorios públicos.You can see proposed updates or new articles in public repositories. Revíselos y agregue sus comentarios.Review them and add your comments. Examine cualquiera de nuestros repositorios de documentos y consulte las solicitudes de incorporación de cambios abiertas para las áreas que le interesen.Look at any of our docs repositories, and check the open pull requests (PRs) for areas that interest you. Los comentarios de la comunidad sobre las actualizaciones propuestas ayudan al conjunto de la comunidad.Community feedback on proposed updates helps the entire community.

Notificación de problemas de calidadCreate quality issues

Nuestros documentos son siempre un trabajo en curso.Our docs are a continuous work in progress. Los problemas positivos nos ayudan a centrar nuestros esfuerzos en las prioridades de la comunidad.Good issues help us focus our efforts on the highest priorities for the community. Cuantos más detalles aporte, más útil será el problema notificado.The more detail you can provide, the more helpful the issue. Díganos qué información buscaba.Tell us what information you sought. O enumere los términos de búsqueda empleó.Tell us the search terms you used. Si no es capaz de comenzar, coméntenos cómo le gustaría empezar a explorar una tecnología desconocida.If you can't get started, tell us how you want to start exploring unfamiliar technology.

Los problemas ayudan a iniciar una conversación sobre lo que hace falta.Issues start the conversation about what's needed. El equipo de contenido responderá a estos problemas con ideas sobre lo que se puede agregar y le pedirá su opinión.The content team will respond to these issues with ideas for what we can add, and ask for your opinions. Cuando creemos un borrador, le pediremos que revise la solicitud de incorporación de cambios.When we create a draft, we'll ask you to review the PR.

Mayor implicaciónGet more involved

Otros temas le ayudarán a empezar a colaborar de manera productiva en Microsoft Docs. En ellos se explica cómo trabajar con repositorios de GitHub, herramientas de Markdown y extensiones usadas en la plataforma de Microsoft Docs.Other topics help you get started productively contributing to Microsoft Docs. They explain working with GitHub repositories, Markdown tools, and extensions used in the Microsoft Docs platform.