rOpenSci | Guia de desenvolvimento da rOpenSci 1.0.0: trilíngue e aprimorado

Guia de desenvolvimento da rOpenSci 1.0.0: trilíngue e aprimorado

A orientação da revisão por pares de Software rOpenSci está reunida em um livro on-line que continua melhorando! Esta postagem do blog resume o que há de novo em nosso Dev Guide 1.0.0, com todas as alterações listadas na seção changelog.

🔗 Agora disponível em português!

O nosso guia agora é trilíngue (Inglês, Espanhol e Português)!

Saiba mais sobre o incrível projeto de tradução para o português, iniciado e impulsionado por nossos membros lusófonos em nossa postagem no blog.

O projeto de tradução e manutenção multilíngue contínua usa o nosso pacote babelquarto para produzir livros e sites multilíngues em Quarto. Ele foi recentemente revisado por pares por Ella Kaye e João Granja-Correia.

Estamos trabalhando ativamente em nosso pacote babeldown para criar e atualizar as traduções usando a API DeepL.

No guia de desenvolvimento, também são mencionadas as ferramentas úteis para internacionalizar pacotes: potools, o pacote experimental rhelpi18n e a seleção de um idioma para um site pkgdown.

🔗 Atualizações de políticas

Fizemos algumas alterações nas políticas e no escopo da rOpenSci:

🔗 Guia para a equipe editorial, guia para revisores e guia para autores de pacotes

Os guias que vivem em nosso guia. 😸

Toda o guia para a equipe editorial foi reestruturado para seguir o fluxo típico de envios e para explicar melhor como usar o painel de revisão de software. Adicionamos uma seção sobre os desafios e documentamos como colocar o sistema em férias (o que geralmente fazemos no período de ano novo).

Da mesma forma, melhoramos a organização e o conteúdo da seção guia para autores (graças ao Alec Robitaille e ao Joan Maspons).

No guia para revisores, removemos o link externo para o guia de revisão da Mozilla que não é mais mantido (uma de nossas primeiras fontes de inspiração para a revisão por pares), em favor de itens enumerados explicitamente.

🔗 Melhores práticas de empacotamento

No guia de desenvolvimento de pacotes (outro guia dentro do guia!), adicionamos orientações para a escolha de exemplos de conjuntos de dados. Além disso, criamos uma seção para pacotes que envolvem software externo. A seção sobre licenças agora exige explicitamente que as pessoas autoras do código incluído sejam mencionadas. Por último, mas não menos importante, a seção sobre dependências recomenda verificar o status de desenvolvimento das dependências.

O livro inteiro agora menciona o CLI do Air sempre que menciona o pacote styler, pois o Air pode ser considerado o seu sucessor.

No capítulo sobre a evolução de pacotes, adicionamos orientações sobre a depreciação de dados e explicamos as desvantagens de renomear um pacote amplamente utilizado.

🔗 Orientação para testes

Atualizamos as nossas diretrizes para testes com

🔗 Documentação do pacote

Um agradecimento especial ao Alasdair Warwick que nos ajudou a melhorar a documentação 😉 do nosso sistema de criação de documentação, incluindo:

Também esclarecemos diferentes estratégias para documentar funções internas graças ao Claudiu Forgaci.

🔗 Metadados e informações do pacote

Documentamos mais maneiras de reconhecer as pessoas colaboradoras:

🔗 Conclusão

Nesta postagem, resumimos as alterações na versão mais recente do nosso livro “Pacotes rOpenSci: Development, Maintenance, and Peer Review” (Desenvolvimento, Manutenção e Revisão por Pares). Somos gratos por todas as contribuições que criaram esta versão. Já estamos trabalhando na próxima versão. Não hesite em nos ajudar a moldá-la, abrindo uma solicitação issue!