Hay varias maneras en las que puede ayudar en el esfuerzo de documentación, dependiendo de cuánta participación desee tener.

  • ¿Solo de paso? Haz una sugerencia casual.

  • ¿Viste algo que no estaba del todo bien? Revise el texto.

  • ¿Te gustaría ver una página en tu idioma? Proporcione una traducción.

  • ¿No encontraste lo que buscabas? Escribe una nueva guía.

Haciendo sugerencias

No tienes que escribir nada si no quieres. Reportar errores o información inexacta ¡también es muy valioso!

En la parte inferior de cada página (incluida esta) hay un enlace a envíe sus comentarios. Este enlace lo llevará a la página de informes de problemas de GitHub. GitHub es el repositorio donde todos Bitxor la documentación está almacenada y es necesario tener una cuenta para acceder a ella (crear una es fácil y gratuito).

Selecciona si quieres reportar un error o hacer una propuesta:

Realmente no importa mucho cuál elijas, GitHub los llama problemas.

Dale a tu problema un título, escribe todos los detalles que puedas sobre él y haz clic en Enviar nuevo problema. ¡Eso es todo!

Nos encargaremos de etiquetar, categorizar y priorizar adecuadamente el tema. No hay nada más que deba hacer, excepto tal vez responder preguntas si las hay. Puedes volver a tu problema en cualquier momento y seguir su evolución.

Revisión y revisión

También existe un mecanismo en caso de que quieras editar una página directamente y sugerir tu propio texto, ya sea una oración, un párrafo o una sección completa.

En la parte superior de la columna derecha de cada artículo (solo visible en pantallas horizontales) hay un enlace para Mejorar esta página. Este enlace abrirá el artículo directamente en el editor de GitHub:

Edita tanto o tan poco como quieras. Las páginas se escriben utilizando ReStructuredText, un lenguaje de marcado de texto sin formato fácil de leer. Si no está familiarizado con él, no se preocupe: cualquier error se detectará en el proceso de revisión.

Cuando haya terminado de editar, desplácese hacia abajo hasta la parte inferior de la página: es hora de confirmar sus cambios y iniciar una solicitud de extracción.

Lo que esto significa es:

  • Debe proporcionar a sus cambios un título breve, una descripción y firmarlos con su correo electrónico. De esta manera, ¡el mundo entero conocerá tu contribución!

  • Sus cambios no se aceptan automáticamente, deben ser revisados en un proceso llamado solicitud de extracción.

Cuando haces clic en Confirmar cambios, se almacenan en una rama. El nombre de la rama propuesto por GitHub (username-patch-1) suele ser lo suficientemente bueno.

Una Solicitud de extracción es el proceso de solicitar que sus cambios sean “extraídos” de su sucursal e incluidos en las páginas públicas. Para hacerlo, simplemente haga clic en el botón Crear solicitud de extracción en la siguiente pantalla.

¡Eso es todo! Su solicitud de extracción recibe un número (como #733) que puede usar para seguir su progreso.

Los mantenedores del repositorio (algunos de estos tipos) serán notificados, revisarán sus cambios y los aceptarán o propondrán modificaciones adicionales. Se le notificará de cada paso a través de su correo electrónico.