From c72c183718a2b97237a834578453206ea2d0b298 Mon Sep 17 00:00:00 2001 From: Paul CARTERON Date: Wed, 12 Apr 2023 08:29:41 +0200 Subject: [PATCH] Prep for cran --- .github/CONTRIBUTING.md | 47 +++++++++++++++++++++++++++++++++++ DESCRIPTION | 16 ++++++------ cran-comments.md | 54 +++++++++++++++++++++++++++++------------ 3 files changed, 94 insertions(+), 23 deletions(-) create mode 100644 .github/CONTRIBUTING.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 00000000..47c10ae9 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,47 @@ +# Contributing to happign + +This outlines how to propose a change to happign. +For more detailed info about contributing to this, and other tidyverse packages, please see the +[**development contributing guide**](https://rstd.io/tidy-contrib). + +## Fixing typos + +You can fix typos, spelling mistakes, or grammatical errors in the documentation directly using the GitHub web interface, as long as the changes are made in the _source_ file. +This generally means you'll need to edit [roxygen2 comments](https://roxygen2.r-lib.org/articles/roxygen2.html) in an `.R`, not a `.Rd` file. +You can find the `.R` file that generates the `.Rd` by reading the comment in the first line. + +## Bigger changes + +If you want to make a bigger change, it's a good idea to first file an issue and make sure someone from the team agrees that it’s needed. +If you’ve found a bug, please file an issue that illustrates the bug with a minimal +[reprex](https://www.tidyverse.org/help/#reprex) (this will also help you write a unit test, if needed). + +### Pull request process + +* Fork the package and clone onto your computer. If you haven't done this before, we recommend using `usethis::create_from_github("paul-carteron/happign", fork = TRUE)`. + +* Install all development dependencies with `devtools::install_dev_deps()`, and then make sure the package passes R CMD check by running `devtools::check()`. + If R CMD check doesn't pass cleanly, it's a good idea to ask for help before continuing. +* Create a Git branch for your pull request (PR). We recommend using `usethis::pr_init("brief-description-of-change")`. + +* Make your changes, commit to git, and then create a PR by running `usethis::pr_push()`, and following the prompts in your browser. + The title of your PR should briefly describe the change. + The body of your PR should contain `Fixes #issue-number`. + +* For user-facing changes, add a bullet to the top of `NEWS.md` (i.e. just below the first header). Follow the style described in . + +### Code style + +* New code should follow the tidyverse [style guide](https://style.tidyverse.org). + You can use the [styler](https://CRAN.R-project.org/package=styler) package to apply these styles, but please don't restyle code that has nothing to do with your PR. + +* We use [roxygen2](https://cran.r-project.org/package=roxygen2), with [Markdown syntax](https://cran.r-project.org/web/packages/roxygen2/vignettes/rd-formatting.html), for documentation. + +* We use [testthat](https://cran.r-project.org/package=testthat) for unit tests. + Contributions with test cases included are easier to accept. + +## Code of Conduct + +Please note that the happign project is released with a +[Contributor Code of Conduct](CODE_OF_CONDUCT.md). By contributing to this +project you agree to abide by its terms. diff --git a/DESCRIPTION b/DESCRIPTION index 6eff81a2..02921760 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -5,12 +5,12 @@ Authors@R: person("Paul", "Carteron", , "carteronpaul@gmail.com", role = c("aut", "cre"), comment = c(ORCID = "0000-0002-6942-6662")) Maintainer: Paul Carteron -Description: Automatic open data acquisition from resources of IGN - ("Institut National de l'Information Géographique et forestière") - (). Available datasets include various types - of raster and vector data, such as digital elevation models, - state borders, spatial databases, cadastral parcels, and more. - There also access to point clouds data (LIDAR) and specifics API +Description: Automatic open data acquisition from resources of IGN + ('Institut National de Information Geographique et forestiere') + (). Available datasets include various types of + raster and vector data, such as digital elevation models, state + borders, spatial databases, cadastral parcels, and more. There also + access to point clouds data ('LIDAR') and specifics API (). License: GPL (>= 3) URL: https://github.com/paul-carteron, @@ -32,8 +32,8 @@ Suggests: httptest2, knitr, rmarkdown, - tmap, - testthat (>= 3.0.0) + testthat (>= 3.0.0), + tmap VignetteBuilder: knitr Config/testthat/edition: 3 diff --git a/cran-comments.md b/cran-comments.md index 725095a1..521eca6e 100644 --- a/cran-comments.md +++ b/cran-comments.md @@ -6,38 +6,62 @@ 0 errors √ | 0 warning x | 0 notes √ -### Online check seem fine as well: +### Online check seem fine as well : -`rhub::check_for_cran()` +/!\ : IGN is a french institut and 'cadastral' is a real word -── happign 0.1.8: NOTE +`rhub::check_for_cran()` +── happign 0.1.9: NOTE - Build ID: happign_0.1.8.tar.gz-891a534869bb46c4a6c137432a1a3f45 + Build ID: happign_0.1.9.tar.gz-0e469a12151f4925a2950695be9198b9 Platform: Windows Server 2022, R-devel, 64 bit - Submitted: 2h 20m 36.8s ago - Build time: 9m 6.7s + Submitted: 17h 16m 1.8s ago + Build time: 6m 14.1s + +❯ checking CRAN incoming feasibility ... [39s] NOTE + Maintainer: 'Paul Carteron ' + + Possibly misspelled words in DESCRIPTION: + IGN (8:64) + cadastral (12:33) ❯ checking for detritus in the temp directory ... NOTE Found the following files/directories: 'lastMiKTeXException' -0 errors ✔ | 0 warnings ✔ | 1 note ✖ +0 errors ✔ | 0 warnings ✔ | 2 notes ✖ -── happign 0.1.8: IN-PROGRESS +── happign 0.1.9: NOTE - Build ID: happign_0.1.8.tar.gz-bc59fc0c59fe482abcbac5703a7681db + Build ID: happign_0.1.9.tar.gz-7ccb2ec226ad4108a48e473ac361eaa7 Platform: Ubuntu Linux 20.04.1 LTS, R-release, GCC - Submitted: 2h 20m 36.9s ago + Submitted: 17h 16m 1.8s ago + Build time: 4h 8m 38.1s +❯ checking CRAN incoming feasibility ... NOTE + Maintainer: ‘Paul Carteron ’ + + Possibly misspelled words in DESCRIPTION: + cadastral (12:33) + IGN (8:64) -── happign 0.1.8: NOTE +0 errors ✔ | 0 warnings ✔ | 1 note ✖ + +── happign 0.1.9: NOTE - Build ID: happign_0.1.8.tar.gz-dc1ca4835e17415d99a534ccdd79e697 + Build ID: happign_0.1.9.tar.gz-db0fa32ae37042389d6b64120191f0e2 Platform: Fedora Linux, R-devel, clang, gfortran - Submitted: 2h 20m 36.9s ago - Build time: 2h 58.8s + Submitted: 17h 16m 1.9s ago + Build time: 3h 34m 36.4s + +❯ checking CRAN incoming feasibility ... [11s/87s] NOTE + Maintainer: ‘Paul Carteron ’ + + Possibly misspelled words in DESCRIPTION: + IGN (8:64) + cadastral (12:33) ❯ checking HTML version of manual ... NOTE Skipping checking HTML validation: no command 'tidy' found -0 errors ✔ | 0 warnings ✔ | 1 note ✖ +0 errors ✔ | 0 warnings ✔ | 2 notes ✖