Skip to contents

Contributing / Cómo contribuir

Source: CONTRIBUTING.md

Issues and pull requests are welcome in English or Spanish. / Se aceptan issues y pull requests en inglés o en español.

The most useful contribution

Endpoint reports. The catalogue is the part of this package most likely to be wrong. If you find an organization publishing WFS or WMS that is missing, or an entry whose URL has moved, open an issue with the endpoint and the organization’s name. Rscript data-raw/probe_endpoints.R produces a health report if you want to check several at once.

Development setup

install.packages(c("devtools", "pkgload"))
devtools::install_deps(dependencies = TRUE)
devtools::load_all()

Before opening a pull request

devtools::document()   # regenerate man/ and NAMESPACE from roxygen
devtools::test()
devtools::check()

Tests must not touch the network. HTTP is replayed from fixtures under tests/testthat/_httptest2/ using httptest2. To record a new fixture, wrap the calls in httptest2::capture_requests() and commit the result.

Conventions

  • Exported functions are prefixed argentum_; internal helpers are prefixed arg_ and marked @noRd.
  • Errors go through cli::cli_abort() with a class argument, so callers can handle them selectively. Add new classes to the list in the getting-started vignette.
  • Roxygen documentation is written in English, which is the convention in the R ecosystem and what CRAN expects. Long-form articles are maintained in both English and Spanish under vignettes/ and vignettes/articles/.
  • Every network call goes through arg_request() / arg_perform(). Do not call httr2 directly from a reader.