15  Preparação do GitHub

Atualmente, os pacotes da rOpenSci são, em sua grande maioria, desenvolvidos no GitHub. Aqui, estão algumas dicas para aproveitar a plataforma em uma seção sobre tornar seu repositório mais detectável e uma seção sobre comercializar sua própria conta do GitHub após passar pela revisão por pares.

15.1 Torne seu repositório mais detectável

15.1.1 Tópicos do repositório do GitHub

Os tópicos de repositórios do GitHub ajudam a navegar e pesquisar repositórios do GitHub, são usados pelo R-universe em páginas de pacotes e para resultados de pesquisa e são processados pelo codemetar para palavras-chave de registro da rOpenSci.

Recomendamos:

  • Adicionar “r”, “r-package” e “rstats” como tópicos ao repositório de seu pacote.

  • Adicionar quaisquer outros tópicos relevantes ao repositório do seu pacote.

Poderemos fazer sugestões a você depois que seu pacote for integrado.

15.1.2 GitHub linguist

O GitHub linguist atribuirá uma linguagem ao seu repositório com base nos arquivos que ele contém. Alguns pacotes que contêm muito código em C++ podem ser classificados como pacotes C++ em vez de pacotes R, o que é bom e mostra a necessidade de adicionar os tópicos “r”, “r-package” e “rstats”.

Recomendamos que você substitua o GitHub linguist adicionando ou modificando um .gitattributes ao seu repositório em dois casos:

  • Se você armazenar arquivos html em locais diferentes do padrão (não em docs/, por exemplo, em vignettes/), use as substituições de documentação. Adicione *.html linguist-documentation=true ao arquivo .gitattributes (Exemplo em uso real)

  • Se o seu repositório contiver código que você não criou, por exemplo, código JavaScript, adicione inst/js/* linguist-vendored a .gitattributes (Exemplo em uso real)

Dessa forma, a classificação da linguagem e as estatísticas do seu repositório refletirão melhor o código-fonte que ele contém, além de torná-lo mais detectável. Notavelmente, se o GitHub linguist não reconhecer corretamente que seu repositório contém principalmente código R, seu pacote não aparecerá nos resultados de pesquisa usando o filtro language:R. Da mesma forma, seu repositório não poderá ser listado entre os repositórios R em alta.

Mais informações sobre as substituições do GitHub linguist podem ser encontradas aqui.

15.2 Comercialize sua própria conta