Enviar una solicitud de extracción

Esta página se trata de enviar una solicitud de extracción que contiene archivos de documentación de Markdown a tensorflow/tfhub.dev . Repositorio de GitHub. Para obtener más información sobre cómo escribir los archivos Markdown en primer lugar, consulte la guía de documentación de escritura .

Comprobaciones de acciones de GitHub

El repositorio tensorflow/tfhub.dev usa GitHub Actions para validar el formato de los archivos en un PR. El flujo de trabajo utilizado para validar los PR se define en .github/workflows/contributions-validator.yml . Puede ejecutar la secuencia de comandos del validador en su propia rama fuera del flujo de trabajo, pero deberá asegurarse de tener instaladas todas las dependencias correctas del paquete pip.

Los contribuyentes por primera vez solo pueden ejecutar comprobaciones automáticas con la aprobación de un responsable del repositorio, según la política de GitHub . Se alienta a los editores a enviar un pequeño PR para corregir errores tipográficos, mejorar la documentación del modelo o enviar un PR que contenga solo su página de editor como su primer PR para poder ejecutar verificaciones automáticas en PR posteriores.

Envío del PR

Los archivos completos de Markdown se pueden extraer a la rama maestra de tensorflow/tfhub.dev mediante uno de los siguientes métodos.

Envío de la CLI de Git

Suponiendo que la ruta del archivo Markdown identificado sea assets/docs/publisher/model/1.md , puede seguir los pasos estándar de Git[Hub] para crear una nueva solicitud de extracción con un archivo recién agregado.

Esto comienza con la bifurcación del repositorio de GitHub de TensorFlow Hub, luego se crea una solicitud de extracción desde esta bifurcación en la rama principal de TensorFlow Hub.

Los siguientes son comandos típicos de CLI git necesarios para agregar un nuevo archivo a una rama maestra del repositorio bifurcado.

git clone https://github.com/[github_username]/tfhub.dev.git
cd tfhub.dev
mkdir -p assets/docs/publisher/model
cp my_markdown_file.md ./assets/docs/publisher/model/1.md
git add *
git commit -m "Added model file."
git push origin master

Envío de GUI de GitHub

Una forma algo más sencilla de enviar es a través de la interfaz gráfica de usuario de GitHub. GitHub permite crear relaciones públicas para archivos nuevos o ediciones de archivos directamente a través de la GUI.

  1. En la página de GitHub de TensorFlow Hub , presione el botón Create new file .
  2. Establezca la ruta de archivo correcta: assets/docs/publisher/model/1.md
  3. Copie y pegue la rebaja existente.
  4. En la parte inferior, seleccione "Crear una nueva rama para esta confirmación e iniciar una solicitud de extracción".