Envie uma solicitação pull

Esta página trata do envio de uma solicitação pull contendo os arquivos de documentação do Markdown para o tensorflow/tfhub.dev . Repositório do GitHub. Para obter mais informações sobre como gravar os arquivos Markdown em primeiro lugar, consulte o guia de documentação de gravação .

Verificações de ações do GitHub

O repositório tensorflow/tfhub.dev usa GitHub Actions para validar o formato dos arquivos em um PR. O fluxo de trabalho usado para validar PRs é definido em .github/workflows/contributions-validator.yml . Você pode executar o script do validador em sua própria ramificação fora do fluxo de trabalho, mas precisará garantir que todas as dependências corretas do pacote pip estejam instaladas.

Os contribuidores iniciantes só podem executar verificações automatizadas com a aprovação de um mantenedor de repositório, de acordo com a política do GitHub . Os editores são incentivados a enviar um pequeno PR corrigindo erros de digitação, melhorando a documentação do modelo ou enviando um PR contendo apenas a página do editor como seu primeiro PR para poder executar verificações automatizadas em PRs subsequentes.

Envio do PR

Os arquivos Markdown completos podem ser inseridos no branch master de tensorflow/tfhub.dev por um dos seguintes métodos.

Envio de CLI do Git

Supondo que o caminho do arquivo de remarcação identificado seja assets/docs/publisher/model/1.md , você pode seguir as etapas padrão do Git[Hub] para criar uma nova Pull Request com um arquivo recém-adicionado.

Isso começa com a bifurcação do repositório GitHub do TensorFlow Hub e, em seguida, criando uma solicitação pull dessa bifurcação para a ramificação principal do TensorFlow Hub.

A seguir estão os comandos git da CLI típicos necessários para adicionar um novo arquivo a um branch master do repositório 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

Envio de GUI do GitHub

Uma maneira um pouco mais direta de enviar é através da interface gráfica do usuário do GitHub. O GitHub permite criar PRs para novos arquivos ou edições de arquivos diretamente por meio da GUI.

  1. Na página do GitHub do TensorFlow Hub , pressione o botão Create new file .
  2. Defina o caminho de arquivo correto: assets/docs/publisher/model/1.md
  3. Copie e cole o markdown existente.
  4. Na parte inferior, selecione "Criar uma nova ramificação para este commit e iniciar uma solicitação pull".