Skip to content

Commit

Permalink
Update issue tracking with advanced search instructions (#169)
Browse files Browse the repository at this point in the history
Close #168
  • Loading branch information
zkamvar authored Apr 7, 2024
1 parent dd1b095 commit 7cd0ed7
Show file tree
Hide file tree
Showing 5 changed files with 58 additions and 1 deletion.
59 changes: 58 additions & 1 deletion 03-issue_tracking.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ To get a Bugzilla account send an e-mail to `bug-report-request@r-project.org` f

### Navigating Bugzilla {#Bugzilla}


An image of the existing home page of Bugzilla is shared below:

![Screenshot of the existing home page of Bugzilla.](img/bugzilla.png)
Expand Down Expand Up @@ -52,3 +51,61 @@ A [quick search](https://bugs.r-project.org/page.cgi?id=quicksearch.html) bar is
There is also a section for Common Queries on the home page which includes links to bugs reported and changed in the last 24 hours and last 7 days.

![Screenshot of the Common Queries section on the home page of Bugzilla.](img/commonquery.png)

## Searching for Bugs to Contribute to {#searching}

When presented with a long list of bugs, it can often be a bit demotivating when it's not clear where to start.
To help with this, you can use the [**Advanced Search**](https://bugs.r-project.org/query.cgi?format=advanced).

![Screenshot of Advanced Search page showing the following fields: Summary, Product, Component, Status, Resolution](img/bugzilla-adv-search-home.png)

This presents several fields that you can use to narrow down your search.
You can find out what a particular field is by clicking on the header, which will take you to that section in the [**Bug Fields Information Page**](https://bugs.r-project.org/page.cgi?id=fields.html).

The default fields are:

- [Summary](https://bugs.r-project.org/page.cgi?id=fields.html#short_desc): a short description of the bug
- [Product](https://bugs.r-project.org/page.cgi?id=fields.html#product): either R or RTools.
- [Component](https://bugs.r-project.org/page.cgi?id=fields.html#component): A specific component of the R toolchain such as Graphics, Documentation, and Models
- [Status](https://bugs.r-project.org/page.cgi?id=fields.html#bug_status): The status of open or closed bugs. This will always default to showing open bugs (UNCONFIRMED, CONFIRMED, and IN_PROGRESS)
- [Resolution](https://bugs.r-project.org/page.cgi?id=fields.html#resolution): The resolution for closed bugs.

You can select multiple items for each field as well.
Both **Product** and **Component** are what you navigate through when you go to [**Browse Issues**](https://bugs.r-project.org/describecomponents.cgi).

Below that are further filters that can help you find bugs you might want to work on:

Detailed Bug Information: Narrow results by the following fields
: Comments, URL, Keywords, Deadline, Bug Numbers, Version, Severity, Priority, Hardware, OS
Search By People
: Narrow results to a role (i.e. Assignee, Reporter, Commenter, etc.) a person has on a bug
Search By Change History
: Narrow results to how fields have changed during a specific time period
Custom Search
: Didn't find what you're looking for above? This area allows for ANDs, ORs, and other more complex searches.

These will be detailed in the subsections below


### Detailed Bug Information {#searching-dbi}

You can use this section to narrow down your search further to filter by things like OS type, R version, Keywords, and Priority.

It can be helpful, for example, to search for bugs labelled with `HELPWANTED`, which indicates bugs that may be suitable for anyone to work on regardless of expertise.

![Screenshot of expanded Detailed Bug Information section showing the following fields: Comment, URL, Keywords (with HELPWANTED entered), Deadline, inclusion/exclusion of bug numbers, Version, Severity, Priority, Hardware, and OS](img/bugzilla-adv-search-detailed-bug-info.png)


### Search By People {#searching-sbp}

You can use this to narrow down your search to only include results of a specific person or up to three people who have participated in any component of the bug's discusson.

![Screenshot of expanded Search By People section showing three fields allowing you to enter a person's name who can be any of the bug assignee, the reporter, a CC list member, or a commenter](img/bugzilla-adv-search-search-by-people.png)


### Search By Change History {#searching-sbch}

Use this to search for bugs where any of the status fields has been changed (which, depending on the change, could indicate that someone from R-Core has given some attention to the bug).
This also provides a date range to narrow your search.

![Screenshot of expanded Search by Change History section showing three fields: where ANY of the fields (multi-select list), changed to, and between (dates in YYYY-MM-DD format)](img/bugzilla-adv-search-search-by-change-history.png)
Binary file added img/bugzilla-adv-search-detailed-bug-info.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/bugzilla-adv-search-home.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/bugzilla-adv-search-search-by-people.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 7cd0ed7

Please sign in to comment.