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

Conversation

SaranjeetKaur
Copy link
Collaborator

@SaranjeetKaur SaranjeetKaur commented Apr 5, 2021

This chapter describes how you can contribute to R by reviewing bug reports.

@SaranjeetKaur SaranjeetKaur marked this pull request as draft April 5, 2021 12:52
@SaranjeetKaur SaranjeetKaur marked this pull request as ready for review April 5, 2021 23:15
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 ☀️ I've made a few wording suggestions.

12-reviewing_bugs.Rmd Outdated Show resolved Hide resolved
12-reviewing_bugs.Rmd Outdated Show resolved Hide resolved
12-reviewing_bugs.Rmd Outdated Show resolved Hide resolved
12-reviewing_bugs.Rmd Outdated Show resolved Hide resolved
12-reviewing_bugs.Rmd Outdated Show resolved Hide resolved
12-reviewing_bugs.Rmd Outdated Show resolved Hide resolved
12-reviewing_bugs.Rmd Outdated Show resolved Hide resolved
12-reviewing_bugs.Rmd Outdated Show resolved Hide resolved
12-reviewing_bugs.Rmd Outdated Show resolved Hide resolved
12-reviewing_bugs.Rmd Outdated Show resolved Hide resolved
SaranjeetKaur and others added 10 commits April 6, 2021 12:37
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>
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

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

Great work! I really liked the introduction to this.

If someone is following the book and using it and reproduces a bug should they post it on Bugzilla that they could reproduce it or not?

I am a bit lost there if I had to provide one for a bug I opened. Perhaps on classifying bug reports I would provide more help on how or where to write a unit test.

@SaranjeetKaur
Copy link
Collaborator Author

Hi @llrs ! Yes, to make things clearer, I am looking for examples where people have acted as reviewers previously on BugZilla. A few examples are collected. More explanation will be provided in this chapter by taking inspiration from those examples. Hope this exercise will increase the clarity of the process.

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.

This is looking good for a first draft Saranjeet. I think we might be able to add more/link to relevant sections when you get to the part about unit tests, to give more guidance on that point.

12-reviewing_bugs.Rmd Outdated Show resolved Hide resolved
12-reviewing_bugs.Rmd Outdated Show resolved Hide resolved
@hturner
Copy link
Member

hturner commented Apr 9, 2021

Regarding @llrs's comment her

If someone is following the book and using it and reproduces a bug should they post it on Bugzilla that they could reproduce it or not?

I think there are two situations this might be useful:

  1. You can provide a far simpler and clearer example to reproduce the issue and/or you needed to do something different from what the original poster said to reproduce the bug (e.g. you needed to load another package to run their code).
  2. A long time has passed without resolution or recent comment, then saying it is still an issue in the current (ideally R-devel) version can be worth saying to bump the issue.

Otherwise, I would say that reproducing the issue should not be shared on Bugzilla, but might be a starting point for working on a fix or a unit test.

@SaranjeetKaur SaranjeetKaur merged commit 9bf50e9 into r-devel:master Apr 12, 2021
@willingc
Copy link
Contributor

Great to see this merged. Go @SaranjeetKaur.

SaranjeetKaur added a commit that referenced this pull request May 25, 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.

4 participants