Bug Tracking #4

SaranjeetKaur · 2021-03-29T13:44:18Z

This chapter describes how bug tracking works in R and its related documentations.

llrs

I have made some comments of this PR. Hope this and the other PR can be merged soon on master.

11-bug_tracking.Rmd

llrs · 2021-04-05T10:02:45Z

11-bug_tracking.Rmd

+
+1. Packages that are supported by the $\textsf{R}$ Core are labelled with `Maintainer: R Core Team <R-core@r-project.org>`. You can check this label either by running `maintainer("package_name")` or by looking at the `Maintainer` field in the output when the command `packageDescription("package_name")` is run in $\textsf{R}$.
+
+2. The bug report for $\textsf{R}$ Core-supported packages and/or their documentations can be submitted either to $\textsf{R}$'s [Bugzilla](https://bugs.r-project.org/bugzilla/) or as an issue to the [GitHub Mirror of R svn server](https://github.com/r-devel/r-svn/issues).


I had the impression that the repo r-devel/r-svn was not officially supported as a place to report bugs. It is only a community effort to make it easier to submit patches. Has this changed? Is there any reference to support this?

Yes, it is still a community effort to make submitting patches and/or issues easier.

Then I would change the wording to something like:

The bug report for $\textsf{R}$ Core-supported packages and/or their documentations must be submitted to $\textsf{R}$'s Bugzilla.

I agree with @llrs, I definitely do not feel that this guide should suggest reporting, tracking, or commenting on bugs in R via the github mirror. My understanding is the same as his.

llrs · 2021-04-05T10:11:57Z

11-bug_tracking.Rmd

+
+2. In $\textsf{R}$ the running 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 $\textbf{RStudio}$.
+
+3. Please ensure that your bug is not already reported or fixed before reporting it in any of the ways suggested above.


If this paragraph is for #nonRCorePkgBug, #RCorePkgBug and the #RLangBug section it should be on a different section or out of this. Perhaps it could be expanded to explain how to ensure that the bug is not already reported or fixed and what to do in those occasions that it is already solved/reported. Some suggestions, search error or function name not the whole code.

11-bug_tracking.Rmd

llrs · 2021-04-05T10:15:28Z

11-bug_tracking.Rmd

+
+1. Include a minimal reproducible example of the bug in your report. The maintainer should be able to quickly reproduce the bug on using the minimal example that you provide.
+
+2. Mention the software architecture on which the bug occurred. 


This section seems only for #RCorePkgBug and the #RLangBug, perhaps it would be better to add a note at the beginning of the section? (Not that for some other packages this information is not relevant but as the links just point to r-project better to be explicit)

llrs · 2021-04-05T10:17:51Z

11-bug_tracking.Rmd

+Once you have successfully reported a bug, you will likely receive an update each time an action is taken on the bug. On Bugzilla, the report may be given one of the following status: New, Assigned, Confirmed, Reopened, Unconfirmed.
+


When I first submitted a bug I didn't know the Severity to give to a bug or the Component to use, perhaps some paragraphs about each element of a bug report will make it easier for people to understand how to make a good bug report on Bugzilla

Yes. This would be good to discuss e.g. at the RCWG and get input from R core members.

11-bug_tracking.Rmd

Co-authored-by: Lluís <llrs@users.noreply.github.com>

SaranjeetKaur · 2021-04-05T23:22:49Z

@llrs I've read all your comments. I am waiting for more reviews on this PR. Then I will start incorporating everyone's suggestions. Thank you so much for your patience!

willingc

Looking good @SaranjeetKaur. I've made a few suggestions along with those that @llrs mentioned.

11-bug_tracking.Rmd

willingc · 2021-04-06T02:07:53Z

11-bug_tracking.Rmd

+
+1. Packages that are supported by the $\textsf{R}$ Core are labelled with `Maintainer: R Core Team <R-core@r-project.org>`. You can check this label either by running `maintainer("package_name")` or by looking at the `Maintainer` field in the output when the command `packageDescription("package_name")` is run in $\textsf{R}$.
+
+2. The bug report for $\textsf{R}$ Core-supported packages and/or their documentations can be submitted either to $\textsf{R}$'s [Bugzilla](https://bugs.r-project.org/bugzilla/) or as an issue to the [GitHub Mirror of R svn server](https://github.com/r-devel/r-svn/issues).


Suggested change

2. The bug report for $\textsf{R}$ Core-supported packages and/or their documentations can be submitted either to $\textsf{R}$'s [Bugzilla](https://bugs.r-project.org/bugzilla/) or as an issue to the [GitHub Mirror of R svn server](https://github.com/r-devel/r-svn/issues).

2. The bug report for $\textsf{R}$ Core-supported packages and/or their documentations can be submitted either to $\textsf{R}$'s [Bugzilla](https://bugs.r-project.org/bugzilla/). In the future, we hope to have an option to report an issue to the [GitHub Mirror of R svn server](https://github.com/r-devel/r-svn/issues).

This looks like a good way to mention the GitHub Mirror of R svn server. Let's see what more suggestions come for this point.

Co-authored-by: Carol Willing <carolcode@willingconsulting.com>

hturner

As Lluis mentioned, it is difficult to get a good overview of the documentation at this stage. So it is hard to get an idea if the logical flow is right or if some information is redundant. But I have made some comments on specific points for you to resolve and I think if address these along with the previous comments made you will have a good first version to merge.

11-bug_tracking.Rmd

rebasing with main branch

rebase the bugzilla branch with forwards/rdevguide main branch

hturner · 2021-04-12T09:14:11Z

The changes all look fine. Just one more thing before we merge: can you use markdown syntax to mark text as bold/italic, etc. I suggest using **bold** for bold text and _italic_ for italic text so that they're clearly distinct.

SaranjeetKaur added 3 commits March 15, 2021 18:20

Using BugZilla

f0f4063

bug_tracking

b5c6c01

bug tracking

07f0c51

SaranjeetKaur marked this pull request as draft March 29, 2021 13:49

SaranjeetKaur added 3 commits April 5, 2021 03:02

Delete 04-lifecycle_of_a_Patch.Rmd

0a12451

references added

a7c660d

Delete 02-getting_started.Rmd

d1663d2

SaranjeetKaur marked this pull request as ready for review April 5, 2021 00:20

llrs reviewed Apr 5, 2021

View reviewed changes

SaranjeetKaur and others added 2 commits April 5, 2021 18:23

Update 11-bug_tracking.Rmd

cc44c61

Co-authored-by: Lluís <llrs@users.noreply.github.com>

Update 11-bug_tracking.Rmd

8675425

Co-authored-by: Lluís <llrs@users.noreply.github.com>

willingc reviewed Apr 6, 2021

View reviewed changes

SaranjeetKaur and others added 6 commits April 6, 2021 12:46

prior to reporting issue

f7ebad2

Co-authored-by: Carol Willing <carolcode@willingconsulting.com>

not a bug condition

00d0958

Co-authored-by: Carol Willing <carolcode@willingconsulting.com>

issue in a clean R session

8014328

Co-authored-by: Carol Willing <carolcode@willingconsulting.com>

confirm a bug exists

93bcee4

Co-authored-by: Carol Willing <carolcode@willingconsulting.com>

consult someone to look over your code

15ac986

Co-authored-by: Carol Willing <carolcode@willingconsulting.com>

github mirror of R svn server

419324a

Co-authored-by: Carol Willing <carolcode@willingconsulting.com>

hturner requested changes Apr 9, 2021

View reviewed changes

SaranjeetKaur added 9 commits April 11, 2021 14:16

minor edits

6f1381a

Merge pull request #6 from forwards/master

50712c1

rebasing with main branch

minor edits

ddd991d

Delete rdevguide.rds

fdcd5b2

use plain text R

1cc257f

change file name

5f46ab9

Delete 11-bug_tracking.Rmd

21bed6c

Merge pull request #10 from forwards/master

903a248

rebase the bugzilla branch with forwards/rdevguide main branch

examples of bug reports added

7558c3b

hturner approved these changes Apr 12, 2021

View reviewed changes

markdown syntax for bold/italic

31c56bc

SaranjeetKaur merged commit b2a5f6e into r-devel:master Apr 12, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Bug Tracking #4

Bug Tracking #4

SaranjeetKaur commented Mar 29, 2021 •

edited

Loading

llrs left a comment

llrs Apr 5, 2021

SaranjeetKaur Apr 5, 2021

llrs Apr 5, 2021

gmbecker Apr 11, 2021

llrs Apr 5, 2021

llrs Apr 5, 2021

llrs Apr 5, 2021

hturner Apr 9, 2021

SaranjeetKaur commented Apr 5, 2021

willingc left a comment

willingc Apr 6, 2021

SaranjeetKaur Apr 6, 2021

hturner left a comment

hturner commented Apr 12, 2021


		1. Packages that are supported by the $\textsf{R}$ Core are labelled with `Maintainer: R Core Team <R-core@r-project.org>`. You can check this label either by running `maintainer("package_name")` or by looking at the `Maintainer` field in the output when the command `packageDescription("package_name")` is run in $\textsf{R}$.

		2. The bug report for $\textsf{R}$ Core-supported packages and/or their documentations can be submitted either to $\textsf{R}$'s [Bugzilla](https://bugs.r-project.org/bugzilla/) or as an issue to the [GitHub Mirror of R svn server](https://github.com/r-devel/r-svn/issues).


		2. In $\textsf{R}$ the running 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 $\textbf{RStudio}$.

		3. Please ensure that your bug is not already reported or fixed before reporting it in any of the ways suggested above.


		1. Include a minimal reproducible example of the bug in your report. The maintainer should be able to quickly reproduce the bug on using the minimal example that you provide.

		2. Mention the software architecture on which the bug occurred.

		Once you have successfully reported a bug, you will likely receive an update each time an action is taken on the bug. On Bugzilla, the report may be given one of the following status: New, Assigned, Confirmed, Reopened, Unconfirmed.

Bug Tracking #4

Bug Tracking #4

Conversation

SaranjeetKaur commented Mar 29, 2021 • edited Loading

llrs left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SaranjeetKaur commented Apr 5, 2021

willingc left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hturner left a comment

Choose a reason for hiding this comment

hturner commented Apr 12, 2021

SaranjeetKaur commented Mar 29, 2021 •

edited

Loading