Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reviewing bugs #5

Merged
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
125 changes: 0 additions & 125 deletions 11-bug_tracking.Rmd

This file was deleted.

81 changes: 40 additions & 41 deletions 12-reviewing_bugs.Rmd
Original file line number Diff line number Diff line change
@@ -1,41 +1,40 @@
# 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.
SaranjeetKaur marked this conversation as resolved.
Show resolved Hide resolved

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:
SaranjeetKaur marked this conversation as resolved.
Show resolved Hide resolved
1. 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.
SaranjeetKaur marked this conversation as resolved.
Show resolved Hide resolved

2. 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/)

### Classifying bug reports

A good bug report is the one which:

1. Clearly explains the bug so that it can be reproduced.
SaranjeetKaur marked this conversation as resolved.
Show resolved Hide resolved

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}$:
SaranjeetKaur marked this conversation as resolved.
Show resolved Hide resolved

1. Reproducing the bug: If you see a bug report which does not clearly explain 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 binary build of $\textsf{R}$. It is helpful to know whether the bug is affecting: `r-patched`, `r-devel`, or `r-release` binary builds of $\textsf{R}$.
SaranjeetKaur marked this conversation as resolved.
Show resolved Hide resolved

3. Writing a unit test: If the bug report lacks a unit test that should be a part of $\textsf{R}$'s test suite, then you can help with providing it.

This is all helpful as it allows the Core developers and/ or maintainers to classify a bug report properly, so that it can be handled in a timely fashion.
SaranjeetKaur marked this conversation as resolved.
Show resolved Hide resolved

### How to find a bug report or an issue that you can help with?
SaranjeetKaur marked this conversation as resolved.
Show resolved Hide resolved

1. You may find old bug reports or issues that can be closed, either because they are no longer valid or they have a patch that is ready to be committed, but no one has had the time to do so.
SaranjeetKaur marked this conversation as resolved.
Show resolved Hide resolved

2. You might also want to search for issues in topics which you have a working knowledge. When on Bugzilla you can use the advanced search for specific topics. Bug reports are by default public on Bugzilla (unless the defaults are changed to avoid security vulnerability), so you can select from them.
SaranjeetKaur marked this conversation as resolved.
Show resolved Hide resolved

## 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/)