Ideias e correções devem primeiro ser registradas como uma issue no GitHub; em seguida qualquer pessoa pode escrever o código e abrir um pull request para revisão.
Para apoio sobre desenvolvimento de pacotes em R, recomendamos o guia R Packages (2e).
Estrutura do pacote
O pacote contém duas famílias de componentes:
-
Família
br_*(atual): construída sobre os assets oficiais do Design System GovBR (@govbr-ds/core), servidos localmente deinst/www/govbr/. Use esta família em novos componentes — vejaROADMAP.mdpara as convenções. - Família legada (derivada do GOV.UK): depreciada desde a versão 0.2.0 (emite aviso) e programada para remoção. Não adicione recursos a ela.
Fluxo de trabalho
- Novas mudanças devem ser feitas em um branch a partir da versão mais recente de
master. - PRs devem apontar para
master; ao merge, usar squash para manter o histórico enxuto. - Rode
devtools::document(),devtools::test()edevtools::check()antes de abrir o PR. - Novos componentes
br_*precisam de arquivo próprio emR/br_<componente>.R, teste espelhado emtests/testthat/test-br_<componente>.R, roxygen com@export,@returne exemploif (interactive()). - Atualize
NEWS.mde, se o componente mudar visualmente, oREADME.md.
Atualizando o Design System GovBR
Os assets são cópias estáticas da distribuição do @govbr-ds/core (atualmente v3.7.0). Passos para atualizar:
- Localize a versão desejada no jsDelivr.
- Baixe
core.min.cssecore.min.jsparainst/www/govbr/, sobrescrevendo os existentes. - Atualize a versão registrada em
R/use_govbr.R(dependenciesgovbr-core-css/govbr-core-js). - Confira os templates de referência em
data-raw/govbr-templates/(baixe os novos se necessário) e valide os markups dos componentes. - Rode
devtools::check()e teste o app de exemplo comshinyGovBRstyle::run_example().
Se inseguro sobre a aparência esperada, consulte a documentação oficial dos componentes em https://www.gov.br/ds/components.
Código de Conduta
Este projeto é distribuído com um Código de Conduta do Colaborador. Ao contribuir, você concorda com seus termos.
