Skip to content

Commit

Permalink
hturner published a site update
Browse files Browse the repository at this point in the history
  • Loading branch information
hturner committed Dec 5, 2024
1 parent ec145b1 commit de87af8
Show file tree
Hide file tree
Showing 25 changed files with 80 additions and 22 deletions.
10 changes: 10 additions & 0 deletions 04-reporting_bugs.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,16 @@ Once you confirm a bug exists, you need to submit a bug report so that it gets f

For packages that are not maintained by the R-Core, the bug reports can be submitted at, perhaps, an issues tracker url on GitHub/GitLab/R-Forge. To find if such an issues tracker is available, you can look at the package `DESCRIPTION` file first (e.g. using `packageDescription("package_name")`) to check if a url is provided in the `BugReports` field. If that is not available, then the package maintainer can be contacted (using `maintainer("package_name")`). In R running the function `bug.report(package = "package_name")` shall direct you to either the GitHub issue tracker of the package, or to the bug tracking web page, or towards composing an e-mail to the package maintainer. This function `bug.report` is disabled in RStudio, by default. However, if you use `utils::bug.report(package = "package_name")` then it works on RStudio as well. Please ensure that the bug is not already reported or fixed before reporting it in any of the ways suggested above.

### Bug in a documentation website managed by the R Core Team {#docWebsRCoreBug}

The R Core Team maintain a selection of websites that each have their own ways for reporting issues outside of Bugzilla. Have a read through the [posting guide for R project mailing lists](https://www.r-project.org/posting-guide.html) and then follow the instructions below to give feedback to the maintainers.

- [R FAQ](https://cran.r-project.org/doc/FAQ/R-FAQ.html) contains answers to some of the most frequently asked questions about R. Feedback on the R FAQ should be sent to the [R-devel mailing list](https://stat.ethz.ch/mailman/listinfo/r-devel) via [[email protected]](mailto:[email protected]).
- [R for Windows FAQ](https://cran.r-project.org/bin/windows/base/rw-FAQ.html) contains answers specific to the Windows port of R. Feedback on the Windows FAQ should be sent to the [R-SIG-windows mailing list](https://stat.ethz.ch/mailman/listinfo/r-sig-windows) (the Special Interest Group for Windows), via [[email protected]](mailto:[email protected]).
- [R for macOS FAQ](https://cran.r-project.org/bin/macosx/RMacOSX-FAQ.html) contains a user guide to the R.APP version of R and information on using R on macOS, supplementing the main R manuals. Feedback on the macOS FAQ should be sent to the [R-SIG-Mac mailing list](https://stat.ethz.ch/mailman/listinfo/r-sig-mac) (the Special Interest Group for Mac ports of R), via [[email protected]](mailto:[email protected]).
- Feedback on the [R Project website](https://www.r-project.org/) should be sent to [[email protected]](mailto:[email protected]).
- Feedback on the website for [The Comprehensive R Archive Network](https://cran.r-project.org/) (CRAN) should be sent to [[email protected]](mailto:[email protected]).

## Good practices in reporting bugs / Expectations of a good bug report {#good-practices-bugs}

If you follow the practices given below, you will come up with a good bug report which might make it easier for the maintainer(s) to fix the bug.
Expand Down
3 changes: 2 additions & 1 deletion 404.html
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
<meta name="author" content="R Contribution Working Group" />


<meta name="date" content="2024-12-04" />
<meta name="date" content="2024-12-05" />

<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="apple-mobile-web-app-capable" content="yes" />
Expand Down Expand Up @@ -195,6 +195,7 @@
<ul>
<li class="chapter" data-level="4.5.1" data-path="ReportingBugs.html"><a href="ReportingBugs.html#RCorePkgBug"><i class="fa fa-check"></i><b>4.5.1</b> Bug in the R-Core supported packages, their documentations, and/ or in the R language</a></li>
<li class="chapter" data-level="4.5.2" data-path="ReportingBugs.html"><a href="ReportingBugs.html#nonRCorePkgBug"><i class="fa fa-check"></i><b>4.5.2</b> Bug in the non R-Core supported packages and/or their documentations</a></li>
<li class="chapter" data-level="4.5.3" data-path="ReportingBugs.html"><a href="ReportingBugs.html#docWebsRCoreBug"><i class="fa fa-check"></i><b>4.5.3</b> Bug in a documentation website managed by the R Core Team</a></li>
</ul></li>
<li class="chapter" data-level="4.6" data-path="ReportingBugs.html"><a href="ReportingBugs.html#good-practices-bugs"><i class="fa fa-check"></i><b>4.6</b> Good practices in reporting bugs / Expectations of a good bug report</a></li>
<li class="chapter" data-level="4.7" data-path="ReportingBugs.html"><a href="ReportingBugs.html#disagreement-with-a-resolution-on-the-bug-tracker"><i class="fa fa-check"></i><b>4.7</b> Disagreement with a resolution on the bug tracker</a></li>
Expand Down
3 changes: 2 additions & 1 deletion CoreDev.html
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
<meta name="author" content="R Contribution Working Group" />


<meta name="date" content="2024-12-04" />
<meta name="date" content="2024-12-05" />

<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="apple-mobile-web-app-capable" content="yes" />
Expand Down Expand Up @@ -195,6 +195,7 @@
<ul>
<li class="chapter" data-level="4.5.1" data-path="ReportingBugs.html"><a href="ReportingBugs.html#RCorePkgBug"><i class="fa fa-check"></i><b>4.5.1</b> Bug in the R-Core supported packages, their documentations, and/ or in the R language</a></li>
<li class="chapter" data-level="4.5.2" data-path="ReportingBugs.html"><a href="ReportingBugs.html#nonRCorePkgBug"><i class="fa fa-check"></i><b>4.5.2</b> Bug in the non R-Core supported packages and/or their documentations</a></li>
<li class="chapter" data-level="4.5.3" data-path="ReportingBugs.html"><a href="ReportingBugs.html#docWebsRCoreBug"><i class="fa fa-check"></i><b>4.5.3</b> Bug in a documentation website managed by the R Core Team</a></li>
</ul></li>
<li class="chapter" data-level="4.6" data-path="ReportingBugs.html"><a href="ReportingBugs.html#good-practices-bugs"><i class="fa fa-check"></i><b>4.6</b> Good practices in reporting bugs / Expectations of a good bug report</a></li>
<li class="chapter" data-level="4.7" data-path="ReportingBugs.html"><a href="ReportingBugs.html#disagreement-with-a-resolution-on-the-bug-tracker"><i class="fa fa-check"></i><b>4.7</b> Disagreement with a resolution on the bug tracker</a></li>
Expand Down
3 changes: 2 additions & 1 deletion DevTools.html
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
<meta name="author" content="R Contribution Working Group" />


<meta name="date" content="2024-12-04" />
<meta name="date" content="2024-12-05" />

<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="apple-mobile-web-app-capable" content="yes" />
Expand Down Expand Up @@ -195,6 +195,7 @@
<ul>
<li class="chapter" data-level="4.5.1" data-path="ReportingBugs.html"><a href="ReportingBugs.html#RCorePkgBug"><i class="fa fa-check"></i><b>4.5.1</b> Bug in the R-Core supported packages, their documentations, and/ or in the R language</a></li>
<li class="chapter" data-level="4.5.2" data-path="ReportingBugs.html"><a href="ReportingBugs.html#nonRCorePkgBug"><i class="fa fa-check"></i><b>4.5.2</b> Bug in the non R-Core supported packages and/or their documentations</a></li>
<li class="chapter" data-level="4.5.3" data-path="ReportingBugs.html"><a href="ReportingBugs.html#docWebsRCoreBug"><i class="fa fa-check"></i><b>4.5.3</b> Bug in a documentation website managed by the R Core Team</a></li>
</ul></li>
<li class="chapter" data-level="4.6" data-path="ReportingBugs.html"><a href="ReportingBugs.html#good-practices-bugs"><i class="fa fa-check"></i><b>4.6</b> Good practices in reporting bugs / Expectations of a good bug report</a></li>
<li class="chapter" data-level="4.7" data-path="ReportingBugs.html"><a href="ReportingBugs.html#disagreement-with-a-resolution-on-the-bug-tracker"><i class="fa fa-check"></i><b>4.7</b> Disagreement with a resolution on the bug tracker</a></li>
Expand Down
3 changes: 2 additions & 1 deletion Doc.html
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
<meta name="author" content="R Contribution Working Group" />


<meta name="date" content="2024-12-04" />
<meta name="date" content="2024-12-05" />

<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="apple-mobile-web-app-capable" content="yes" />
Expand Down Expand Up @@ -195,6 +195,7 @@
<ul>
<li class="chapter" data-level="4.5.1" data-path="ReportingBugs.html"><a href="ReportingBugs.html#RCorePkgBug"><i class="fa fa-check"></i><b>4.5.1</b> Bug in the R-Core supported packages, their documentations, and/ or in the R language</a></li>
<li class="chapter" data-level="4.5.2" data-path="ReportingBugs.html"><a href="ReportingBugs.html#nonRCorePkgBug"><i class="fa fa-check"></i><b>4.5.2</b> Bug in the non R-Core supported packages and/or their documentations</a></li>
<li class="chapter" data-level="4.5.3" data-path="ReportingBugs.html"><a href="ReportingBugs.html#docWebsRCoreBug"><i class="fa fa-check"></i><b>4.5.3</b> Bug in a documentation website managed by the R Core Team</a></li>
</ul></li>
<li class="chapter" data-level="4.6" data-path="ReportingBugs.html"><a href="ReportingBugs.html#good-practices-bugs"><i class="fa fa-check"></i><b>4.6</b> Good practices in reporting bugs / Expectations of a good bug report</a></li>
<li class="chapter" data-level="4.7" data-path="ReportingBugs.html"><a href="ReportingBugs.html#disagreement-with-a-resolution-on-the-bug-tracker"><i class="fa fa-check"></i><b>4.7</b> Disagreement with a resolution on the bug tracker</a></li>
Expand Down
3 changes: 2 additions & 1 deletion FeatureRequests.html
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
<meta name="author" content="R Contribution Working Group" />


<meta name="date" content="2024-12-04" />
<meta name="date" content="2024-12-05" />

<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="apple-mobile-web-app-capable" content="yes" />
Expand Down Expand Up @@ -195,6 +195,7 @@
<ul>
<li class="chapter" data-level="4.5.1" data-path="ReportingBugs.html"><a href="ReportingBugs.html#RCorePkgBug"><i class="fa fa-check"></i><b>4.5.1</b> Bug in the R-Core supported packages, their documentations, and/ or in the R language</a></li>
<li class="chapter" data-level="4.5.2" data-path="ReportingBugs.html"><a href="ReportingBugs.html#nonRCorePkgBug"><i class="fa fa-check"></i><b>4.5.2</b> Bug in the non R-Core supported packages and/or their documentations</a></li>
<li class="chapter" data-level="4.5.3" data-path="ReportingBugs.html"><a href="ReportingBugs.html#docWebsRCoreBug"><i class="fa fa-check"></i><b>4.5.3</b> Bug in a documentation website managed by the R Core Team</a></li>
</ul></li>
<li class="chapter" data-level="4.6" data-path="ReportingBugs.html"><a href="ReportingBugs.html#good-practices-bugs"><i class="fa fa-check"></i><b>4.6</b> Good practices in reporting bugs / Expectations of a good bug report</a></li>
<li class="chapter" data-level="4.7" data-path="ReportingBugs.html"><a href="ReportingBugs.html#disagreement-with-a-resolution-on-the-bug-tracker"><i class="fa fa-check"></i><b>4.7</b> Disagreement with a resolution on the bug tracker</a></li>
Expand Down
3 changes: 2 additions & 1 deletion FindSource.html
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
<meta name="author" content="R Contribution Working Group" />


<meta name="date" content="2024-12-04" />
<meta name="date" content="2024-12-05" />

<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="apple-mobile-web-app-capable" content="yes" />
Expand Down Expand Up @@ -195,6 +195,7 @@
<ul>
<li class="chapter" data-level="4.5.1" data-path="ReportingBugs.html"><a href="ReportingBugs.html#RCorePkgBug"><i class="fa fa-check"></i><b>4.5.1</b> Bug in the R-Core supported packages, their documentations, and/ or in the R language</a></li>
<li class="chapter" data-level="4.5.2" data-path="ReportingBugs.html"><a href="ReportingBugs.html#nonRCorePkgBug"><i class="fa fa-check"></i><b>4.5.2</b> Bug in the non R-Core supported packages and/or their documentations</a></li>
<li class="chapter" data-level="4.5.3" data-path="ReportingBugs.html"><a href="ReportingBugs.html#docWebsRCoreBug"><i class="fa fa-check"></i><b>4.5.3</b> Bug in a documentation website managed by the R Core Team</a></li>
</ul></li>
<li class="chapter" data-level="4.6" data-path="ReportingBugs.html"><a href="ReportingBugs.html#good-practices-bugs"><i class="fa fa-check"></i><b>4.6</b> Good practices in reporting bugs / Expectations of a good bug report</a></li>
<li class="chapter" data-level="4.7" data-path="ReportingBugs.html"><a href="ReportingBugs.html#disagreement-with-a-resolution-on-the-bug-tracker"><i class="fa fa-check"></i><b>4.7</b> Disagreement with a resolution on the bug tracker</a></li>
Expand Down
3 changes: 2 additions & 1 deletion FixBug.html
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
<meta name="author" content="R Contribution Working Group" />


<meta name="date" content="2024-12-04" />
<meta name="date" content="2024-12-05" />

<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="apple-mobile-web-app-capable" content="yes" />
Expand Down Expand Up @@ -195,6 +195,7 @@
<ul>
<li class="chapter" data-level="4.5.1" data-path="ReportingBugs.html"><a href="ReportingBugs.html#RCorePkgBug"><i class="fa fa-check"></i><b>4.5.1</b> Bug in the R-Core supported packages, their documentations, and/ or in the R language</a></li>
<li class="chapter" data-level="4.5.2" data-path="ReportingBugs.html"><a href="ReportingBugs.html#nonRCorePkgBug"><i class="fa fa-check"></i><b>4.5.2</b> Bug in the non R-Core supported packages and/or their documentations</a></li>
<li class="chapter" data-level="4.5.3" data-path="ReportingBugs.html"><a href="ReportingBugs.html#docWebsRCoreBug"><i class="fa fa-check"></i><b>4.5.3</b> Bug in a documentation website managed by the R Core Team</a></li>
</ul></li>
<li class="chapter" data-level="4.6" data-path="ReportingBugs.html"><a href="ReportingBugs.html#good-practices-bugs"><i class="fa fa-check"></i><b>4.6</b> Good practices in reporting bugs / Expectations of a good bug report</a></li>
<li class="chapter" data-level="4.7" data-path="ReportingBugs.html"><a href="ReportingBugs.html#disagreement-with-a-resolution-on-the-bug-tracker"><i class="fa fa-check"></i><b>4.7</b> Disagreement with a resolution on the bug tracker</a></li>
Expand Down
3 changes: 2 additions & 1 deletion GetStart.html
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
<meta name="author" content="R Contribution Working Group" />


<meta name="date" content="2024-12-04" />
<meta name="date" content="2024-12-05" />

<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="apple-mobile-web-app-capable" content="yes" />
Expand Down Expand Up @@ -195,6 +195,7 @@
<ul>
<li class="chapter" data-level="4.5.1" data-path="ReportingBugs.html"><a href="ReportingBugs.html#RCorePkgBug"><i class="fa fa-check"></i><b>4.5.1</b> Bug in the R-Core supported packages, their documentations, and/ or in the R language</a></li>
<li class="chapter" data-level="4.5.2" data-path="ReportingBugs.html"><a href="ReportingBugs.html#nonRCorePkgBug"><i class="fa fa-check"></i><b>4.5.2</b> Bug in the non R-Core supported packages and/or their documentations</a></li>
<li class="chapter" data-level="4.5.3" data-path="ReportingBugs.html"><a href="ReportingBugs.html#docWebsRCoreBug"><i class="fa fa-check"></i><b>4.5.3</b> Bug in a documentation website managed by the R Core Team</a></li>
</ul></li>
<li class="chapter" data-level="4.6" data-path="ReportingBugs.html"><a href="ReportingBugs.html#good-practices-bugs"><i class="fa fa-check"></i><b>4.6</b> Good practices in reporting bugs / Expectations of a good bug report</a></li>
<li class="chapter" data-level="4.7" data-path="ReportingBugs.html"><a href="ReportingBugs.html#disagreement-with-a-resolution-on-the-bug-tracker"><i class="fa fa-check"></i><b>4.7</b> Disagreement with a resolution on the bug tracker</a></li>
Expand Down
3 changes: 2 additions & 1 deletion IssueTrack.html
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
<meta name="author" content="R Contribution Working Group" />


<meta name="date" content="2024-12-04" />
<meta name="date" content="2024-12-05" />

<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="apple-mobile-web-app-capable" content="yes" />
Expand Down Expand Up @@ -195,6 +195,7 @@
<ul>
<li class="chapter" data-level="4.5.1" data-path="ReportingBugs.html"><a href="ReportingBugs.html#RCorePkgBug"><i class="fa fa-check"></i><b>4.5.1</b> Bug in the R-Core supported packages, their documentations, and/ or in the R language</a></li>
<li class="chapter" data-level="4.5.2" data-path="ReportingBugs.html"><a href="ReportingBugs.html#nonRCorePkgBug"><i class="fa fa-check"></i><b>4.5.2</b> Bug in the non R-Core supported packages and/or their documentations</a></li>
<li class="chapter" data-level="4.5.3" data-path="ReportingBugs.html"><a href="ReportingBugs.html#docWebsRCoreBug"><i class="fa fa-check"></i><b>4.5.3</b> Bug in a documentation website managed by the R Core Team</a></li>
</ul></li>
<li class="chapter" data-level="4.6" data-path="ReportingBugs.html"><a href="ReportingBugs.html#good-practices-bugs"><i class="fa fa-check"></i><b>4.6</b> Good practices in reporting bugs / Expectations of a good bug report</a></li>
<li class="chapter" data-level="4.7" data-path="ReportingBugs.html"><a href="ReportingBugs.html#disagreement-with-a-resolution-on-the-bug-tracker"><i class="fa fa-check"></i><b>4.7</b> Disagreement with a resolution on the bug tracker</a></li>
Expand Down
3 changes: 2 additions & 1 deletion News.html
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
<meta name="author" content="R Contribution Working Group" />


<meta name="date" content="2024-12-04" />
<meta name="date" content="2024-12-05" />

<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="apple-mobile-web-app-capable" content="yes" />
Expand Down Expand Up @@ -195,6 +195,7 @@
<ul>
<li class="chapter" data-level="4.5.1" data-path="ReportingBugs.html"><a href="ReportingBugs.html#RCorePkgBug"><i class="fa fa-check"></i><b>4.5.1</b> Bug in the R-Core supported packages, their documentations, and/ or in the R language</a></li>
<li class="chapter" data-level="4.5.2" data-path="ReportingBugs.html"><a href="ReportingBugs.html#nonRCorePkgBug"><i class="fa fa-check"></i><b>4.5.2</b> Bug in the non R-Core supported packages and/or their documentations</a></li>
<li class="chapter" data-level="4.5.3" data-path="ReportingBugs.html"><a href="ReportingBugs.html#docWebsRCoreBug"><i class="fa fa-check"></i><b>4.5.3</b> Bug in a documentation website managed by the R Core Team</a></li>
</ul></li>
<li class="chapter" data-level="4.6" data-path="ReportingBugs.html"><a href="ReportingBugs.html#good-practices-bugs"><i class="fa fa-check"></i><b>4.6</b> Good practices in reporting bugs / Expectations of a good bug report</a></li>
<li class="chapter" data-level="4.7" data-path="ReportingBugs.html"><a href="ReportingBugs.html#disagreement-with-a-resolution-on-the-bug-tracker"><i class="fa fa-check"></i><b>4.7</b> Disagreement with a resolution on the bug tracker</a></li>
Expand Down
Loading

0 comments on commit de87af8

Please sign in to comment.