Skip to content

Commit

Permalink
Tweak reprexing advice
Browse files Browse the repository at this point in the history
Fixes #1625
  • Loading branch information
hadley committed Sep 21, 2021
1 parent 9ec2bac commit 29a1b3b
Showing 1 changed file with 4 additions and 8 deletions.
12 changes: 4 additions & 8 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,21 +13,17 @@ example of a minimal package was [this issue](https://github.com/r-lib/pkgdown/i
where a minimal package containing a single `.R` file with two lines could reproduce
the error.

Once you have built a minimal package that recreates the error, create a GitHub
repository from the package, and file an issue with a link to the repository.

The quickest way to set up minimal example package is with `usethis::create_package()`:

```R
library(usethis)
library(pkgdown)

tmp <- file.path(tempdir(), "test")
usethis::create_package(tmp, open)
usethis::create_package("~/desktop/testpackage")
# ... edit files ...
pkgdown::build_site(tmp, new_process = FALSE, preview = FALSE)
```

Once you have built a minimal package that recreates the error, create a GitHub
repository from the package (e.g. with `usethis::use_git()` + `usethis::use_github()`), and file an issue with a link to the repository.

## Rd translation

If you encounter problems with Rd tags, please use `rd2html()` to create a reprexes:
Expand Down

0 comments on commit 29a1b3b

Please sign in to comment.