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

PE: how to respond to bug reports that are nitpicking in nature? #130

Open
AaronCQL opened this issue Apr 18, 2020 · 6 comments
Open

PE: how to respond to bug reports that are nitpicking in nature? #130

AaronCQL opened this issue Apr 18, 2020 · 6 comments

Comments

@AaronCQL
Copy link

For example, bugs which report

  • Minor typos
  • Diagrams too large (not that it is too complex, just purely large in size)
  • Diagrams too small
  • Diagrams too complicated (very debatable)
  • Suggestions to reorder sections of the user/developer guide
@okkhoy
Copy link

okkhoy commented Apr 18, 2020

  • Suggestions -> Can reject
  • Minor typos & Diagram too small -> low severity, accept ('cos affects readability)
  • Diagrams too large -> can reject, unless diagram not fully visible in PDF, if latter case, low severity accept
  • Too complicated -> accept; severity depends on how you want to defend your choice can be low or medium

@raivatshah
Copy link

raivatshah commented Apr 18, 2020

Thanks prof! Should we accept typos as small as missing a "" character while closing a special typing in ASCII Doc?

@okkhoy
Copy link

okkhoy commented Apr 18, 2020

Probably not. But this is an indication that you need to be careful 😜

@raivatshah
Copy link

Haha! Thanks prof! We will be careful in the future!

@CornCobs
Copy link

My group accepted issues that were minor typo corrections, formatting or suggestions, as we had no good reason to reject them (We assume that rejecting mean you disagree with the issue raised, but how can we disagree with a typo?)

I assume this will not matter as the tutors will go through the issues eventually?

@okkhoy
Copy link

okkhoy commented Apr 21, 2020

Yes, the teaching team will go through the issues.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants