Directrices de contribución

Guías de documentación

Tu participación es clave para mejorar la experiencia de la documentación de VTEX. Existen distintas maneras de colaborar, dependiendo del portal de documentación que te interese y del método que prefieras. Esta guía describe las formas en que puedes contribuir para optimizar la documentación de VTEX:

Botón de feedback
¿Te ha parecido útil?
Sugerir cambios (GitHub)

Botón de feedback

Disponible en: Help Center y Developer Portal

Puedes enviar tus comentarios sobre cualquier página de los portales de documentación haciendo clic en Feedback en la esquina superior derecha de cada portal.

${"base64":" ","img":{"width":1893,"height":914,"type":"gif","mime":"image/gif","wUnits":"px","hUnits":"px","length":208667,"url":"https://vtexhelp.vtexassets.com/assets/docs/src/doc-feedback-form___21b3eb638614c18bf9b51f91e834a380.gif"}}$

Al hacer clic en Feedback se abrirá una nueva ventana del navegador con un formulario para que nos envíes tus comentarios. Consulta a continuación la información que debes proporcionar en el formulario:

Platform: selecciona uno de los siguientes portales sobre el que deseas enviar tu feedback: Help Center, Developer Portal, o VTEX Learning Center.
URL (opcional): si deseas enviar comentarios sobre una página específica de uno de los portales mencionados anteriormente, agrega la URL exacta de la página, por ejemplo: https://developers.vtex.com/docs/guides/getting-started-with-storefront-solutions.
Feedback type: Elige el tipo de comentario que deseas enviar:

Tipo de feedback	Descripción
Comment	Deja un comentario sobre la documentación.
Question	Indica cualquier duda o pregunta que tengas acerca del contenido.
Error	Reporta información incorrecta o señala si la página presenta algún problema o no está disponible.
Improvement	Sugiere posibles mejoras o ajustes para optimizar el contenido.

Feedback: detalla tus comentarios según el tipo de feedback que hayas elegido.
Suggestions (opcional): agrega cualquier sugerencia para corregir o mejorar el contenido.
Attachment (opcional): si tienes archivos adicionales para compartir, como capturas de pantalla, imágenes u hojas de cálculo, cárgalos en esta sección.
Follow-up: si deseas que nos pongamos en contacto contigo para hablar sobre tus comentarios, selecciona Yes y agrega tu nombre e email en la siguiente página del formulario.

¿Te ha parecido útil?

Disponible en: Help Center y Developer Portal

Puedes enviar tus comentarios sobre cualquier página de los portales de documentación haciendo clic en el pulgar arriba o abajo en ¿Te ha parecido útil?

${"base64":" ","img":{"width":1881,"height":777,"type":"gif","mime":"image/gif","wUnits":"px","hUnits":"px","length":2682081,"url":"https://vtexhelp.vtexassets.com/assets/docs/src/was-this-helpful___f7a0bfefa5147947c2bb4d11baa31e22.gif"}}$

En el Developer Portal, además de indicar si te gustó o no la página con el pulgar arriba o abajo, también puedes dejar un comentario sobre la página y explicar por qué te pareció útil o no. Haz clic en SEND FEEDBACK para enviar tus comentarios.

Sugerir cambios (GitHub)

Disponible en: Help Center y Developer Portal

Puedes contribuir a cualquier página en los portales de documentación haciendo clic en Sugerir cambios (GitHub).

${"base64":" ","img":{"width":1881,"height":777,"type":"gif","mime":"image/gif","wUnits":"px","hUnits":"px","length":971251,"url":"https://vtexhelp.vtexassets.com/assets/docs/src/suggest-edits-github___fff6aa05ddc4031e99a38b84c1d91aeb.gif"}}$

Al hacer clic en Sugerir cambios (GitHub), se abrirá una nueva ventana del navegador con la página del repositorio de la documentación. Sigue estos pasos para realizar tus sugerencias a través de Sugerir cambios (GitHub):

En la página del repositorio de la documentación edita el archivo que deseas modificar.

Asegúrate de que tus aportes sigan los principios de las directrices de documentación y el código de conducta.
Haz clic en Commit changes….

En la ventana modal Propose changes llena los siguientes datos requeridos:

Nombre del campo	Descripción
Commit message	Escribe una breve descripción de tu commit, por ejemplo, `Fix typo`.
Extended description (Optional)	Agrega más detalles sobre tu commit, si es necesario.
Create a new branch for this commit and start a pull request	Asigna un nombre a la nueva rama para poder abrir un pull request y que el equipo pueda revisar tus sugerencias.

Una vez llenado el formulario, haz clic en Propose changes.

Crea un pull request con los cambios propuestos completando lo siguiente:

${"base64":" ","img":{"width":1642,"height":840,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":79854,"url":"https://vtexhelp.vtexassets.com/assets/docs/src/open-pull-request___2181e6b6116f8427f47435992da98723.png"}}$

Nombre del campo	Descripción
Add a title	Agrega un título a tu pull request indicando el tipo de cambio, el nombre del archivo y lo que modificaste. Por ejemplo: `Fix (customer-credit-integration-guide.md): Documentation typos`.
Add a description	Verifica el tipo de cambio que estás proponiendo: New content, Improvement, Fix o Spelling and grammar accuracy. Además, puedes incluir más detalles en la descripción para ayudar al equipo a revisar tu sugerencia.
Reviewers	Haz clic en `Reviewers` y selecciona el grupo `vtexdocs/vtex-education`.

Haz clic en Create pull request.

Una vez que hayas abierto el pull request, nuestro equipo revisará tus cambios lo antes posible y se pondrá en contacto a través de los comentarios del pull request.

Los pull requests son un proceso colaborativo. Valoramos tus sugerencias, pero su aprobación no está garantizada. Ten en cuenta que los cambios propuestos pueden recibir feedback o ser discutidos por otros colaboradores.