From 75818aa0072f3e0a37356de49761cc3b0668d924 Mon Sep 17 00:00:00 2001 From: Saranjeet Kaur Date: Mon, 5 Apr 2021 18:19:47 +0530 Subject: [PATCH 1/6] add chapter on reviewing bug reports --- 12-reviewing_bugs.Rmd | 119 +++++++++++++++++++++++++++--------------- 1 file changed, 78 insertions(+), 41 deletions(-) diff --git a/12-reviewing_bugs.Rmd b/12-reviewing_bugs.Rmd index 0254a05..00dc919 100644 --- a/12-reviewing_bugs.Rmd +++ b/12-reviewing_bugs.Rmd @@ -1,41 +1,78 @@ -# Reviewing Bugs - -## Python triage team - -## Becoming a member of the Python triage team - -### GitHub Labels for PRs - -## Fields in the Bug Tracker - -### Title - -### Type - -### Stage - -### Components - -### Versions - -### Priority - -### Keywords - -### Nosy List - -### Assigned To - -### Dependencies - -### Superseder - -### Status - -### Resolution - -### Mercurial Repository - -## Generating Special Links in a Comment - -## Checklist for Triaging +# Reviewing Bugs + +## How you can help to review bug reports? + +Once you are aware where bugs are reported in $\textsf{R}$, a great way to contribute is to help reviewing the bug reports. + +Around the clock, new bug reports are being submitted on Bugzilla or the bug trackers (for instance, GitHub issues) of $\textsf{R}$ packages and existing bug reports are being updated. Every bug report needs to be reviewed to make sure various things are in proper order. You can help with this process of reviewing bugs. + +Note: If you want to review bug reports on Bugzilla, you are required to have a Bugzilla account. To get a Bugzilla account send an e-mail to `bug-report-request@r-project.org` from the address you want to use as your login. Briefly explain why you want a Bugzilla account and a volunteer will add you to $\textsf{R}$'s Bugzilla members. + +### Classifying bug reports + +A good bug report is the one which: + +1. Clearly explains the bug so that it can be reproduced. + +2. Includes the version of $\textsf{R}$, the machine architecture, and the operating system platform on which the bug occurred. + +These are the relevant details that should be a part of a good bug report. You can help with these things once you have experience developing for $\textsf{R}$: + +1. Reproducing the bug: If you see a bug report which does not clearly explains how to reproduce it, you can try reproducing the bug and eventually make things easier for the core developer(s) and/or package maintainer(s). + +2. Check whether the bug occurs on a different version of $\textsf{R}$. It is helpful to know if a bug is not only affecting the + +### Reviewing Patches + +### Finding an Issue You Can Help With + +## Gaining the “Developer” Role on the Bug Tracker + +## The Meta Tracker + +More details on how you can review a bug report are available on this [blog](https://developer.r-project.org/Blog/public/2019/10/09/r-can-use-your-help-reviewing-bug-reports/) + + +## Python triage team + +## Becoming a member of the Python triage team + +### GitHub Labels for PRs + +## Fields in the Bug Tracker + +### Title + +### Type + +### Stage + +### Components + +### Versions + +### Priority + +### Keywords + +### Nosy List + +### Assigned To + +### Dependencies + +### Superseder + +### Status + +### Resolution + +### Mercurial Repository + +## Generating Special Links in a Comment + +## Checklist for Triaging + +## See also + +1. [Reviewing bug reports: Blog](https://developer.r-project.org/Blog/public/2019/10/09/r-can-use-your-help-reviewing-bug-reports/) From b865225ef33b2da328f6608b9c4ede60cb46528d Mon Sep 17 00:00:00 2001 From: Saranjeet Kaur Date: Sun, 11 Apr 2021 14:06:16 +0530 Subject: [PATCH 2/6] edits added --- 02-getting_started.Rmd | 88 +++++++++++++++++++++++++++++------------- 1 file changed, 61 insertions(+), 27 deletions(-) diff --git a/02-getting_started.Rmd b/02-getting_started.Rmd index 4adf735..b898b27 100755 --- a/02-getting_started.Rmd +++ b/02-getting_started.Rmd @@ -1,27 +1,61 @@ -# Getting Started - -## Install git - -## Get the source code - -## Compile and build - -### UNIX - -### Windows - -## Install dependencies - -### Linux - -### maxOS and OS X - -## Regenerate `configure` - -## Troubleshoot the build - -### Avoid recreating auto-generated files - -## Editors and Tools - -## Directory structure +# Getting Started + +These instructions cover how to install $\textsf{R}$ in Windows. The tools required to build $\textsf{R}$ and $\textsf{R}$ packages in Windows are also discussed. + +## General instructions + +1. If you install the latest version or R-patched or R-devel, it will not over-write the previous installation(s) in your Windows machine. + +2. R uses a ‘major.minor.patchlevel’ version numbering scheme. Accordingly there are three main releases of $\textsf{R}$ available to install: + + * The official release (`r-release`), + + * The patched release (`r-patched`), and + + * The development (`r-devel`) release. + +The `r-devel` is the next minor or eventually major release development version of $\textsf{R}$. Mostly, bug fixes are introduced in `r-patched`, while `r-devel` is for introducing new features. + +## Installing $\textsf{R}$ + +1. The binary builds of $\textsf{R}$ for Windows can be downloaded and installed from [here](https://cran.r-project.org/bin/windows/base/). Along with the link to the latest stable release, this page also contains links to the binary builds of r-patched and r-devel. + +2. Click on the download links to download an executable installer. + +3. Select the language while installing, read the public license information, and select destination location to the start the installation. You will be prompted to select components at this stage: `User installation`, `32-bit User installation`, `64-bit User installation`, or `Custom installation`. The default option may be opted for the questions from this step onwards to complete the installation. + +## Building $\textsf{R}$ and $\textsf{R}$ packages + +### What tools you need to build $\textsf{R}$ from source on Windows? + +1. [RTools](https://github.com/r-windows/docs/blob/master/faq.md#what-is-rtools) is the toolchain bundle that you can use to build $\textsf{R}$ base and $\textsf{R}$ packages containing compiled code, on Windows. + +2. You also need a distribution of $\LaTeX$ installed for building $\textsf{R}$ and checking packages. The `MiKTeX` distribution of $\LaTeX$ that is used on CRAN can be downloaded from https://miktex.org. + +### How to setup `RTools`? + +1. The latest version of `RTools` can be downloaded from https://cran.r-project.org/bin/windows/Rtools/ and run in the Windows-style installer. You will need to know if you have a 32-bit or 64-bit Windows machine (right-click `This PC` in Windows Explorer and check the properties if you are unsure). + +2. Don't forget to add `RTools` to the path as documented on the download page. + +### How to build $\textsf{R}$? + +To build $\textsf{R}$ for Windows using `RTools` follow the instructions in this [README](https://github.com/r-windows/r-base#readme) file. There are two options available to build $\textsf{R}$. One is the quick development build and the other option is the full installer build. + +For development and testing, you need only the quick development build. The quick build avoids building the manuals, which are generally not needed for development and testing. + +However, even for the quick build there are some [default requirements](https://github.com/r-windows/r-base/blob/master/quick-build.sh). For instance, `MikTeX` is to be installed in `C:/Program Files` and you have 64-bit $\textsf{R}$. If necessary, these defaults can be customised. The installation path of `MikTex` can be customised [here](https://github.com/r-windows/r-base/blob/50a229fc76c50a5fb42c0daa367466aaf2318171/quick-build.sh#L13) whereas the Windows bit can be customised [here](https://github.com/r-windows/r-base/blob/50a229fc76c50a5fb42c0daa367466aaf2318171/quick-build.sh#L6). + +If you are a maintainer of the Windows CRAN releases then, the full installer build is available for building the complete installer as it appears on CRAN. It will build both the 32-bit and 64-bit $\textsf{R}$, the pdf manuals, and the installer program. You will use this to create the binary builds and not when building $\textsf{R}$ from the source yourself. + +## See also + +1. [CRAN official website](https://cran.r-project.org) + +2. [R installation and administration manual](https://cran.r-project.org/doc/manuals/r-patched/R-admin.html) + +3. [R for Windows FAQ](https://cran.r-project.org/bin/windows/base/rw-FAQ.html) + +4. [Rtools40 manual for Windows](https://cran.r-project.org/bin/windows/Rtools/) + +5. [R FAQ](https://cran.r-project.org/doc/FAQ/R-FAQ.html) From 6946a62e5e61161e7ac279673c6999f2bfd51455 Mon Sep 17 00:00:00 2001 From: Saranjeet Kaur Date: Mon, 12 Apr 2021 11:52:59 +0530 Subject: [PATCH 3/6] Delete 12-reviewing_bugs.Rmd --- 12-reviewing_bugs.Rmd | 78 ------------------------------------------- 1 file changed, 78 deletions(-) delete mode 100644 12-reviewing_bugs.Rmd diff --git a/12-reviewing_bugs.Rmd b/12-reviewing_bugs.Rmd deleted file mode 100644 index 00dc919..0000000 --- a/12-reviewing_bugs.Rmd +++ /dev/null @@ -1,78 +0,0 @@ -# Reviewing Bugs - -## How you can help to review bug reports? - -Once you are aware where bugs are reported in $\textsf{R}$, a great way to contribute is to help reviewing the bug reports. - -Around the clock, new bug reports are being submitted on Bugzilla or the bug trackers (for instance, GitHub issues) of $\textsf{R}$ packages and existing bug reports are being updated. Every bug report needs to be reviewed to make sure various things are in proper order. You can help with this process of reviewing bugs. - -Note: If you want to review bug reports on Bugzilla, you are required to have a Bugzilla account. To get a Bugzilla account send an e-mail to `bug-report-request@r-project.org` from the address you want to use as your login. Briefly explain why you want a Bugzilla account and a volunteer will add you to $\textsf{R}$'s Bugzilla members. - -### Classifying bug reports - -A good bug report is the one which: - -1. Clearly explains the bug so that it can be reproduced. - -2. Includes the version of $\textsf{R}$, the machine architecture, and the operating system platform on which the bug occurred. - -These are the relevant details that should be a part of a good bug report. You can help with these things once you have experience developing for $\textsf{R}$: - -1. Reproducing the bug: If you see a bug report which does not clearly explains how to reproduce it, you can try reproducing the bug and eventually make things easier for the core developer(s) and/or package maintainer(s). - -2. Check whether the bug occurs on a different version of $\textsf{R}$. It is helpful to know if a bug is not only affecting the - -### Reviewing Patches - -### Finding an Issue You Can Help With - -## Gaining the “Developer” Role on the Bug Tracker - -## The Meta Tracker - -More details on how you can review a bug report are available on this [blog](https://developer.r-project.org/Blog/public/2019/10/09/r-can-use-your-help-reviewing-bug-reports/) - - -## Python triage team - -## Becoming a member of the Python triage team - -### GitHub Labels for PRs - -## Fields in the Bug Tracker - -### Title - -### Type - -### Stage - -### Components - -### Versions - -### Priority - -### Keywords - -### Nosy List - -### Assigned To - -### Dependencies - -### Superseder - -### Status - -### Resolution - -### Mercurial Repository - -## Generating Special Links in a Comment - -## Checklist for Triaging - -## See also - -1. [Reviewing bug reports: Blog](https://developer.r-project.org/Blog/public/2019/10/09/r-can-use-your-help-reviewing-bug-reports/) From 1026ef3a4ccefc85e35debabf94c2cb6c8f38199 Mon Sep 17 00:00:00 2001 From: Saranjeet Kaur Date: Sun, 2 May 2021 23:16:35 +0530 Subject: [PATCH 4/6] add file --- where_to_get_help.Rmd | 44 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) create mode 100644 where_to_get_help.Rmd diff --git a/where_to_get_help.Rmd b/where_to_get_help.Rmd new file mode 100644 index 0000000..4bd7e39 --- /dev/null +++ b/where_to_get_help.Rmd @@ -0,0 +1,44 @@ +# Where to get help + +If you are working on R it is possible that you will come across an issue where you would need some assistance to solve it. If you require help, there are options available to seek assistance or get some feedback which are discussed in this chapter. If the question involves process or tool usage then please check the rest of this guide first as it should answer your question. Please be polite, patient, and respectful of people's time while you ask for feedback or help. + +## Mailing Lists + +There are quite a few [mailing lists](https://www.r-project.org/mail.html) for getting help with R: + + * [R-help](https://stat.ethz.ch/mailman/listinfo/r-help): + * Discussions about problems and solutions using R. + * Announcements about the development of R. + * Announcements about the availability of new code. + * Enhancements and patches to the R source code and the R documentation. + * Comparison and compatibilty with S and S-plus. + * Posting examples and benchmarks. + + * [R-package-devel](https://stat.ethz.ch/mailman/listinfo/r-package-devel): + * Getting help about package development in R. + * Learning about the package development process. + * Discussing problems developing a package (or problem in passing the R CMD check). + + * [R-devel](https://stat.ethz.ch/mailman/listinfo/r-devel): + * Questions and discussion about code development in R. + * Proposals of new functionality for R. + * Pre-testing of new versions of R. + +Please avoid cross-posting to both the R-package-devel and the R-devel mailing lists. + +## Slack + +You can try asking and get feedback on the [R-devel slack](https://r-devel.slack.com/), before submitting to Bugzilla. There are a number of experienced developers on this slack who can answer questions and/or provide feedback. The following channels are available on the R-devel slack for help and feedback with specific areas: + + * #bugreports-for-review: Share bug report for review/feedback before submitting to Bugzilla. + * #core-dev-help: Getting help on anything related to R Core contribution. + * #core-documentation: Discuss patches/improvements to R's documentation. + * #core-translation: Discuss translating R into non-English languages. + * #patches-for-review: Share patches for peer review before submitting to R Core. + +Note: You may not be able to access the history of these channels, so it cannot be used as a knowledge base of sorts. + + +## File a Bug + +If you strongly suspect you have come across a bug (be it in the build process, or in other areas), then report it on Bugzilla. As with every bug report it is strongly advised that you detail which conditions triggered it (including the OS name and version, and what you were trying to do), as well as the exact error message you encountered. From 7af0cf7eb27b834ea8a1bcbb9f1dde96ef063454 Mon Sep 17 00:00:00 2001 From: Saranjeet Kaur Date: Fri, 14 May 2021 09:17:22 +0530 Subject: [PATCH 5/6] reorganizing the chapter --- where_to_get_help.Rmd | 42 +++++++++++++++++++++--------------------- 1 file changed, 21 insertions(+), 21 deletions(-) diff --git a/where_to_get_help.Rmd b/where_to_get_help.Rmd index 4bd7e39..6f5623c 100644 --- a/where_to_get_help.Rmd +++ b/where_to_get_help.Rmd @@ -1,11 +1,29 @@ -# Where to get help +# Where to get help {#WhereToGetHelp} -If you are working on R it is possible that you will come across an issue where you would need some assistance to solve it. If you require help, there are options available to seek assistance or get some feedback which are discussed in this chapter. If the question involves process or tool usage then please check the rest of this guide first as it should answer your question. Please be polite, patient, and respectful of people's time while you ask for feedback or help. +If you are working on R it is possible that you will come across an issue where you would need some assistance to solve it. If you require help, there are options available to seek assistance or get some feedback which are discussed in this chapter. If the question involves process or tool usage then please check the rest of this guide first as it should answer your question. Please make sure to search the documentation and resources to see if your question has already been addressed. If not, then ask for assistance in the appropriate forum. Many developers are volunteers and please be polite, patient, and thoughtful when requesting for feedback or help. + +## Slack + +You can discuss issues related to the development of R and learn about the process of contributing to R on the [R-devel slack](https://r-devel.slack.com/). There are a number of experienced developers on this slack who can answer questions and/or provide feedback. The following channels are available on the R-devel slack for help and feedback with specific areas: + + * #bugreports-for-review: Share bug reports for review/feedback before submitting to Bugzilla. + * #core-dev-help: Getting help on anything related to R Core contribution. + * #core-documentation: Discuss patches/improvements to R's documentation. + * #core-translation: Discuss translating R messages, warnings, and errors into non-English languages. + * #patches-for-review: Share patches for peer review before submitting to R Core. + +Note: You may not be able to access the history of these channels, so it cannot be used as a knowledge base of sorts. ## Mailing Lists There are quite a few [mailing lists](https://www.r-project.org/mail.html) for getting help with R: + * [R-devel](https://stat.ethz.ch/mailman/listinfo/r-devel): + * Questions and discussion about development _of_ R vs. _with_ R. + * Getting help with technical programming issues, e.g. interfacing R with C/C++. + * Proposals of new functionality for R. + * Pre-testing of new versions of R. + * [R-help](https://stat.ethz.ch/mailman/listinfo/r-help): * Discussions about problems and solutions using R. * Announcements about the development of R. @@ -19,26 +37,8 @@ There are quite a few [mailing lists](https://www.r-project.org/mail.html) for g * Learning about the package development process. * Discussing problems developing a package (or problem in passing the R CMD check). - * [R-devel](https://stat.ethz.ch/mailman/listinfo/r-devel): - * Questions and discussion about code development in R. - * Proposals of new functionality for R. - * Pre-testing of new versions of R. - Please avoid cross-posting to both the R-package-devel and the R-devel mailing lists. -## Slack - -You can try asking and get feedback on the [R-devel slack](https://r-devel.slack.com/), before submitting to Bugzilla. There are a number of experienced developers on this slack who can answer questions and/or provide feedback. The following channels are available on the R-devel slack for help and feedback with specific areas: - - * #bugreports-for-review: Share bug report for review/feedback before submitting to Bugzilla. - * #core-dev-help: Getting help on anything related to R Core contribution. - * #core-documentation: Discuss patches/improvements to R's documentation. - * #core-translation: Discuss translating R into non-English languages. - * #patches-for-review: Share patches for peer review before submitting to R Core. - -Note: You may not be able to access the history of these channels, so it cannot be used as a knowledge base of sorts. - - ## File a Bug -If you strongly suspect you have come across a bug (be it in the build process, or in other areas), then report it on Bugzilla. As with every bug report it is strongly advised that you detail which conditions triggered it (including the OS name and version, and what you were trying to do), as well as the exact error message you encountered. +If you strongly suspect you have come across a bug (be it in the build process, or in other areas), then [report it on Bugzilla](#ReportBug). \ No newline at end of file From 556db89c41163c7aacd4cb1a8b10c8d445d41eca Mon Sep 17 00:00:00 2001 From: Saranjeet Kaur Date: Fri, 14 May 2021 12:52:08 +0530 Subject: [PATCH 6/6] minor changes --- where_to_get_help.Rmd | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/where_to_get_help.Rmd b/where_to_get_help.Rmd index 6f5623c..3ed1989 100644 --- a/where_to_get_help.Rmd +++ b/where_to_get_help.Rmd @@ -7,9 +7,13 @@ If you are working on R it is possible that you will come across an issue where You can discuss issues related to the development of R and learn about the process of contributing to R on the [R-devel slack](https://r-devel.slack.com/). There are a number of experienced developers on this slack who can answer questions and/or provide feedback. The following channels are available on the R-devel slack for help and feedback with specific areas: * #bugreports-for-review: Share bug reports for review/feedback before submitting to Bugzilla. + * #core-dev-help: Getting help on anything related to R Core contribution. + * #core-documentation: Discuss patches/improvements to R's documentation. + * #core-translation: Discuss translating R messages, warnings, and errors into non-English languages. + * #patches-for-review: Share patches for peer review before submitting to R Core. Note: You may not be able to access the history of these channels, so it cannot be used as a knowledge base of sorts. @@ -23,15 +27,12 @@ There are quite a few [mailing lists](https://www.r-project.org/mail.html) for g * Getting help with technical programming issues, e.g. interfacing R with C/C++. * Proposals of new functionality for R. * Pre-testing of new versions of R. - - * [R-help](https://stat.ethz.ch/mailman/listinfo/r-help): - * Discussions about problems and solutions using R. - * Announcements about the development of R. - * Announcements about the availability of new code. * Enhancements and patches to the R source code and the R documentation. - * Comparison and compatibilty with S and S-plus. * Posting examples and benchmarks. + * [R-help](https://stat.ethz.ch/mailman/listinfo/r-help): + * Discussions about problems and solutions using R. + * [R-package-devel](https://stat.ethz.ch/mailman/listinfo/r-package-devel): * Getting help about package development in R. * Learning about the package development process.