Esta página é sobre o envio de uma solicitação pull contendo arquivos de documentação Markdown para o tensorflow/tfhub.dev . Repositório GitHub. Para obter mais informações sobre como gravar os arquivos Markdown, consulte o guia de documentação de gravação .
Verificações de ações do GitHub
O repositório tensorflow/tfhub.dev usa o 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 do 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 nos PRs subsequentes.
Enviando o PR
Os arquivos Markdown completos podem ser inseridos na ramificação principal de tensorflow/tfhub.dev por um dos métodos a seguir.
Envio da CLI do Git
Supondo que o caminho do arquivo markdown identificado seja assets/docs/publisher/model/1.md , você pode seguir as etapas padrão do Git[Hub] para criar uma nova solicitação pull com um arquivo recém-adicionado.
Isso começa com a bifurcação do repositório GitHub do TensorFlow Hub e, em seguida, a criação de uma solicitação pull dessa bifurcação para a ramificação principal do TensorFlow Hub.
A seguir estão os comandos git CLI típicos necessários para adicionar um novo arquivo a uma ramificação principal 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 da GUI do GitHub
Uma maneira um pouco mais direta de enviar é por meio da interface gráfica do usuário do GitHub. O GitHub permite a criação de PRs para novos arquivos ou edições de arquivos diretamente por meio da GUI.
- Na página GitHub do TensorFlow Hub , pressione o botão
Create new file. - Defina o caminho correto do arquivo:
assets/docs/publisher/model/1.md - Copie e cole a remarcação existente.
- Na parte inferior, selecione "Create a new branch for this commit and start a pull request".