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 3e44390266e6326ae9534a511002e2ff2cc8d0eb Mon Sep 17 00:00:00 2001 From: Saranjeet Kaur Date: Sat, 1 May 2021 23:11:04 +0530 Subject: [PATCH 4/6] list of R Core team --- R_Core_Developers.Rmd | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 R_Core_Developers.Rmd diff --git a/R_Core_Developers.Rmd b/R_Core_Developers.Rmd new file mode 100644 index 0000000..60e7da3 --- /dev/null +++ b/R_Core_Developers.Rmd @@ -0,0 +1,33 @@ +# R Core Developers + +This page lists the former and current members of the R Core team who have write access to the R source. + + * Brian Ripley (present) + * Deepayan Sarkar (present) + * Douglas Bates (present) + * Duncan Murdoch (up to September 2017) + * Duncan Temple Lang (present) + * Friedrich Leisch (present) + * Guido Masarotto (up to June 2003) + * Heiner Schwarte (up to October 1999) + * John Chambers (present) + * Kurt Hornik (present) + * Luke Tierney (present) + * Martin Maechler (present) + * Martin Morgan (present) + * Martyn Plummer (present) + * Michael Lawrence (present) + * Paul Murrell (present) + * Peter Dalgaard (present) + * Robert Gentleman (present) + * Ross Ihaka (present) + * Seth Falcon (up to August 2015) + * Simon Urbanek (present) + * Stefano lacus (up to July 2014) + * Thomas Lumley (present) + * Tomas Kalibera (present) + * Uwe Ligges (present) + +Affiliations of R Core team members are available [here](link to the page listing the bios most likely on the R project website--to-do). + +Contributors, outside the R Core team, who provided invaluable help by donating code, bug fixes, and documentation are listed [here](https://www.r-project.org/contributors.html). \ No newline at end of file From c38c9b8790c1776aa1dfa7a236675cfb0ab5eb02 Mon Sep 17 00:00:00 2001 From: Saranjeet Kaur Date: Sun, 2 May 2021 02:01:11 +0530 Subject: [PATCH 5/6] TODO URL bios comment --- R_Core_Developers.Rmd | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/R_Core_Developers.Rmd b/R_Core_Developers.Rmd index 60e7da3..fd4fea8 100644 --- a/R_Core_Developers.Rmd +++ b/R_Core_Developers.Rmd @@ -28,6 +28,7 @@ This page lists the former and current members of the R Core team who have write * Tomas Kalibera (present) * Uwe Ligges (present) -Affiliations of R Core team members are available [here](link to the page listing the bios most likely on the R project website--to-do). +Affiliations of R Core team members are available [here](). + -Contributors, outside the R Core team, who provided invaluable help by donating code, bug fixes, and documentation are listed [here](https://www.r-project.org/contributors.html). \ No newline at end of file +Contributors, outside the R Core team, who provided invaluable help by donating code, bug fixes, and documentation are listed [here](https://www.r-project.org/contributors.html). From d486a89f78f80409398d0470566575e391b7012e Mon Sep 17 00:00:00 2001 From: Saranjeet Kaur Date: Fri, 14 May 2021 13:11:10 +0530 Subject: [PATCH 6/6] change hypertext --- R_Core_Developers.Rmd | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/R_Core_Developers.Rmd b/R_Core_Developers.Rmd index fd4fea8..0716429 100644 --- a/R_Core_Developers.Rmd +++ b/R_Core_Developers.Rmd @@ -28,7 +28,7 @@ This page lists the former and current members of the R Core team who have write * Tomas Kalibera (present) * Uwe Ligges (present) -Affiliations of R Core team members are available [here](). +View the [affiliations of R Core members](). We've left it up to the individual core developers to list areas of expertise (or things they are willing to maintain) if they wish. -Contributors, outside the R Core team, who provided invaluable help by donating code, bug fixes, and documentation are listed [here](https://www.r-project.org/contributors.html). +The [Contributors page on the R Project website](https://www.r-project.org/contributors.html) also lists contributors, outside the R Core team, who provided invaluable help by donating code, bug fixes, and documentation. \ No newline at end of file