Sugerir cambios en la documentación

|nombre del sitio| es un proyecto de código abierto y nos encanta recibir contribuciones de nuestra comunidad: ¡tú! Hay muchas formas de contribuir, desde redactar guías, mejorar la documentación, enviar errores y solicitudes o escribir nuevas piezas de documentación que se pueden incorporar en los propios documentos.

Informes de errores

Si cree que ha encontrado un error en el |nombre del sitio|, primero asegúrese de que está probando con la última versión de |nombre del sitio|; es posible que su problema ya se haya solucionado. De lo contrario, busque en nuestra lista de problemas en GitHub en caso de que ocurra algo similar. |problema| ya ha sido abierto.

Es muy útil si puede preparar una reproducción del error. Hace que sea más fácil encontrar el problema y solucionarlo.

Por favor, tenga en cuenta la siguiente plantilla para reportar su problema:

Describa el error

Una descripción clara y concisa de cuál es el error.

Reproducir

Pasos para reproducir el comportamiento:

  1. Vaya a ‘…’

  2. Haga clic en ‘….’

  3. Desplácese hacia abajo hasta ‘….’

  4. Ver error

Comportamiento esperado

Una descripción clara y concisa de lo que esperaba que sucediera.

Capturas de pantalla

Si corresponde, agregue capturas de pantalla para ayudar a explicar su problema.

Abrir un nuevo |número| aquí.

Peticiones

Si te encuentras deseando contenido que no existe en el |nombre del sitio|, probablemente no estés solo. La mayor parte de la documentación y guías que el |nombre del sitio| ha sido agregado hoy porque nuestros usuarios vieron la necesidad. Abrir un |problema| en nuestra lista de problemas en GitHub que describe la documentación que falta o la mejora que le gustaría ver.

Si la mejora no está relacionada con la documentación, sino con un proyecto específico, consulte CONTRIBUTING.md en el repositorio del proyecto.

Cambios en el código y la documentación que contribuyen

Para ampliar y mejorar |nombre del sitio|, busque o abra un |problema| sobre eso primero. Hable acerca de lo que le gustaría hacer. Puede ser que alguien ya esté trabajando en ello, o que haya problemas particulares que deba conocer antes de implementar el cambio.

Nos gusta trabajar con colaboradores para que se acepten sus solicitudes de incorporación de cambios.

Construyendo bitxor-docs

Si el cambio en la documentación es pequeño, puede usar el botón “Editar en Github” en la parte superior de la página.

Para cambios o contribuciones sustanciales, es posible que deba bifurcar el principal |repositorio| y clonarlo en su máquina local. Ver |github-ayuda| página de ayuda.

Primero, asegúrese de tener instalado Python 2.7 o 3.4+ y pip.

Luego, instale los requisitos usando pip:

pip install -r requirements.txt

Ejecute el siguiente comando y abra la URL proporcionada en un navegador.

make livehtml

Enviando sus cambios

Una vez que sus cambios y pruebas estén listos para enviarlos a revisión:

  1. Pruebe sus cambios.

    Ejecute make livehtml y obtenga una vista previa de sus cambios.

  2. Envíe una solicitud de extracción.

    Empuje sus cambios locales a su copia bifurcada del repositorio y submit a pull request. En la solicitud de extracción, elija un título que resuma los cambios que ha realizado y, en el cuerpo, proporcione más detalles sobre lo que hacen sus cambios. También mencione el número de la cuestión en la que ha tenido lugar la discusión, por ejemplo, “Cierra #123”.

    Entonces siéntate y espera. Probablemente habrá una discusión sobre la solicitud de extracción y, si se necesitan cambios, nos encantaría trabajar con usted para fusionar su solicitud de extracción en bitxor-docs.

Aviso de licencia de contribución

Cuando contribuye con código, afirma que la contribución es su trabajo original y que otorga la licencia del trabajo al proyecto bajo la licencia de código abierto del proyecto.

Ya sea que indique esto explícitamente o no, al enviar cualquier material protegido por derechos de autor a través de una solicitud de extracción, correo electrónico u otros medios, acepta licenciar el material bajo la licencia de código abierto del proyecto y garantiza que tiene la autoridad legal para hacerlo.

CONTRIBUTING.md is based on CONTRIBUTING-template.md , elasticsearch/CONTRIBUTING and spark/CONTRIBUTING.