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

Bug Tracking #4

Merged
merged 24 commits into from
Apr 12, 2021
Merged

Conversation

SaranjeetKaur
Copy link
Collaborator

@SaranjeetKaur SaranjeetKaur commented Mar 29, 2021

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

@SaranjeetKaur SaranjeetKaur marked this pull request as draft March 29, 2021 13:49
@SaranjeetKaur SaranjeetKaur marked this pull request as ready for review April 5, 2021 00:20
Copy link
Member

@llrs llrs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

11-bug_tracking.Rmd Outdated Show resolved Hide resolved
11-bug_tracking.Rmd Outdated Show resolved Hide resolved
11-bug_tracking.Rmd Outdated Show resolved Hide resolved
11-bug_tracking.Rmd Outdated Show resolved Hide resolved

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).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Then I would change the wording to something like:

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.


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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 Outdated Show resolved Hide resolved

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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)

Comment on lines 109 to 110
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.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

11-bug_tracking.Rmd Outdated Show resolved Hide resolved
SaranjeetKaur and others added 2 commits April 5, 2021 18:23
Co-authored-by: Lluís <llrs@users.noreply.github.com>
Co-authored-by: Lluís <llrs@users.noreply.github.com>
@SaranjeetKaur
Copy link
Collaborator Author

@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!

Copy link
Contributor

@willingc willingc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

11-bug_tracking.Rmd Outdated Show resolved Hide resolved
11-bug_tracking.Rmd Outdated Show resolved Hide resolved
11-bug_tracking.Rmd Outdated Show resolved Hide resolved
11-bug_tracking.Rmd Outdated Show resolved Hide resolved
11-bug_tracking.Rmd Outdated Show resolved Hide resolved

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).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

SaranjeetKaur and others added 6 commits April 6, 2021 12:46
Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
Copy link
Member

@hturner hturner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 Outdated Show resolved Hide resolved
11-bug_tracking.Rmd Outdated Show resolved Hide resolved
11-bug_tracking.Rmd Outdated Show resolved Hide resolved
11-bug_tracking.Rmd Outdated Show resolved Hide resolved
11-bug_tracking.Rmd Outdated Show resolved Hide resolved
11-bug_tracking.Rmd Outdated Show resolved Hide resolved
11-bug_tracking.Rmd Outdated Show resolved Hide resolved
11-bug_tracking.Rmd Outdated Show resolved Hide resolved
11-bug_tracking.Rmd Outdated Show resolved Hide resolved
@hturner
Copy link
Member

hturner commented Apr 12, 2021

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 SaranjeetKaur merged commit b2a5f6e into r-devel:master Apr 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants