forked from r-lib/pkgdown
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
usethis::use_tidy_contributing() (r-lib#826)
Added instructions and examples to CONTRIBUTING for providing a minimal package for debugging in the context of a pkgdown build. Moved CODE_OF_CONDUCT to .github/ and updated links.
- Loading branch information
1 parent
77ceb8c
commit 747abdc
Showing
4 changed files
with
68 additions
and
6 deletions.
There are no files selected for viewing
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
# pkgdown build issues | ||
|
||
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](https://github.com/r-lib/pkgdown/issues/720#issuecomment-397606145), | ||
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 pacakge, and file an issue with a link to the repository. | ||
|
||
The quickest way to set up minimal example package is with `usethis::create_package()`. | ||
|
||
# Contributing to pkgdown | ||
|
||
This outlines how to propose a change to pkgdown. 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 | ||
|
||
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. | ||
|
||
* YES: you edit a roxygen comment in a `.R` file below `R/`. | ||
* NO: you edit an `.Rd` file below `man/`. | ||
|
||
### Prerequisites | ||
|
||
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](https://www.tidyverse.org/help/#reprex). | ||
|
||
### Pull request process | ||
|
||
* We recommend that you create a Git branch for each pull request (PR). | ||
* Look at the Travis and AppVeyor build status before and after making changes. | ||
The `README` should contain badges for any continuous integration services used | ||
by the package. | ||
* New code should follow the tidyverse [style guide](http://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/markdown.html), | ||
for documentation. | ||
* We use [testthat](https://cran.r-project.org/package=testthat). Contributions | ||
with test cases included are easier to accept. | ||
* For user-facing changes, add a bullet to the top of `NEWS.md` below the | ||
current development version header describing the changes made followed by your | ||
GitHub username, and links to relevant issue(s)/PR(s). | ||
|
||
### Code of Conduct | ||
|
||
Please note that the pkgdown 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. | ||
|
||
### See tidyverse [development contributing guide](https://rstd.io/tidy-contrib) | ||
for further details. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters