This document outlines how to propose a change to pkgdown. For more detailed info about contributing to this and other tidyverse packages, please see the tidyverse contribution guide.
If you encounter unexpected errors after running
pkgdown::build_site(), try to build a minimal package that recreates the error. An ideal minimal package has no dependencies, making it easy to install and quickly reproduce the error. An example of a minimal package was this issue, 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
If you encounter problems with Rd tags, please use
rd2html() to create a reprexes:
READMEshould contain badges for any continuous integration services used by the package.
NEWS.mdbelow the current development version header describing the changes made followed by your GitHub username, and links to relevant issue(s)/PR(s).
We might ask you for a Netlify preview of your changes i.e. how do your local changes affect the pkgdown website?
build_site()) which will update the docs/ folder.
docs/, and drag the
docs/folder to the dashed box, which will copy all the files into a temporary netlify site.
Small typos or grammatical errors in documentation may be edited directly using the GitHub web interface, so long as the changes are made in the source file.
Before you make a substantial pull request, you should always file an issue and make sure someone from the team agrees that it’s a problem. If you’ve found a bug, create an associated issue and illustrate the bug with a minimal reprex.
Please note that the pkgdown project is released with a Contributor Code of Conduct. By contributing to this project you agree to abide by its terms.