Writing Bug Reports!!!
================
I would like share couple points on writing bug reports with you all.
Bug Reports that say nothing ("It doesn't work!"); reports that make no sense; reports that don't give enough information; reports that give wrong information. Reports of problems that turn out to be user error; reports of problems that turn out to be the fault of somebody else's program; reports of problems that turn out to be network failures.
The aim of a bug report is to enable the programmer to see the program failing in front of them. You can either show them in person, or give them careful and detailed instructions on how to make it fail. If they can make it fail, they will try to gather extra information until they know the cause. If they can't make it fail, they will have to ask you to gather that information for them.
In bug reports, try to make very clear what are actual facts ("I was at the computer and this happened") and what are speculations ("I think the problem might be this"). Leave out speculations if you want to, but don't leave out facts.
When you report a bug, you are doing so because you want the bug fixed. There is no point in swearing at the programmer or being deliberately unhelpful: it may be their fault and your problem, and you might be right to be angry with them, but the bug will get fixed faster if you help them by supplying all the information they need.
I would like share couple points on writing bug reports with you all.
Bug Reports that say nothing ("It doesn't work!"); reports that make no sense; reports that don't give enough information; reports that give wrong information. Reports of problems that turn out to be user error; reports of problems that turn out to be the fault of somebody else's program; reports of problems that turn out to be network failures.
The aim of a bug report is to enable the programmer to see the program failing in front of them. You can either show them in person, or give them careful and detailed instructions on how to make it fail. If they can make it fail, they will try to gather extra information until they know the cause. If they can't make it fail, they will have to ask you to gather that information for them.
In bug reports, try to make very clear what are actual facts ("I was at the computer and this happened") and what are speculations ("I think the problem might be this"). Leave out speculations if you want to, but don't leave out facts.
When you report a bug, you are doing so because you want the bug fixed. There is no point in swearing at the programmer or being deliberately unhelpful: it may be their fault and your problem, and you might be right to be angry with them, but the bug will get fixed faster if you help them by supplying all the information they need.
So remember below points while writing bug reports!!!
Logging Bugs:Few points to remember:
============================
1. Clearly mention repro steps (step by step don't assume anything) Give test data effectively
2. Actual Result/ Expected result: Divide into points rather than big sentences. Instead of only telling about the issue, stress on the impact it has caused or do some analysis and mention the root cause of the issue (as applicable), this is where we can do Value Addition.
3. Try to provide snapshots/video where ever applicable and mention file/folder name in repro steps.
4. Check spell before saving your message.
5. Don't use short cuts words in repro steps ex: Pls for please.. Immly for Immediately...
6. Don’t log bugs with multiple issues unless they are inter-related and caused because of one thing.
7. Don’t ignore as small issues, log them as low priority bugs, its upto them to fix/ not
8. If you are seeing any inconsistent issues, don’t neglect it, spend some time to find consistent repro. Still you can file bugs giving different scenarios where it likely repros
9. If you see any major issues on your machine, PLEASE check on some other machine as well, before logging it OR Send a mail to team ( If you get any such mails PLEASE try it out without fail (if not immly, at least some time before EOD) and send-in your observations. Confirm even if its not repro to you)
10. If you are not sure whether it’s a bug/ By Design, don’t keep with your self, and bring to my notice.
1. Clearly mention repro steps (step by step don't assume anything) Give test data effectively
2. Actual Result/ Expected result: Divide into points rather than big sentences. Instead of only telling about the issue, stress on the impact it has caused or do some analysis and mention the root cause of the issue (as applicable), this is where we can do Value Addition.
3. Try to provide snapshots/video where ever applicable and mention file/folder name in repro steps.
4. Check spell before saving your message.
5. Don't use short cuts words in repro steps ex: Pls for please.. Immly for Immediately...
6. Don’t log bugs with multiple issues unless they are inter-related and caused because of one thing.
7. Don’t ignore as small issues, log them as low priority bugs, its upto them to fix/ not
8. If you are seeing any inconsistent issues, don’t neglect it, spend some time to find consistent repro. Still you can file bugs giving different scenarios where it likely repros
9. If you see any major issues on your machine, PLEASE check on some other machine as well, before logging it OR Send a mail to team ( If you get any such mails PLEASE try it out without fail (if not immly, at least some time before EOD) and send-in your observations. Confirm even if its not repro to you)
10. If you are not sure whether it’s a bug/ By Design, don’t keep with your self, and bring to my notice.
Check list when bug/s are fixed:
=======================
Few points to remember
Read whole bug ( all the comments in Scope, Attached mail threads if any, relevant linked bugs) and not just the Repro Steps and see all the issues mentioned/discussed are fixed
If the fix is 100%, close the message.
If it caused any new issues ( which are minor) , close it – log new messages for other issues.
If the fix caused major regressions, activate/reopen this one by clearly mentioning the impact of this fix.
Re-activating bug/s:
Few points to remember
Read whole bug ( all the comments in Scope, Attached mail threads if any, relevant linked bugs) and not just the Repro Steps and see all the issues mentioned/discussed are fixed
If the fix is 100%, close the message.
If it caused any new issues ( which are minor) , close it – log new messages for other issues.
If the fix caused major regressions, activate/reopen this one by clearly mentioning the impact of this fix.
Re-activating bug/s:
===============
1.Only in case of (Cross check on second machine, before re-activating any messages.)
A. If it fails directly as per the Repro steps
B. If it causes major regressions
2. But try to provide any extra info than given in the bug for better understanding to the Dev/ PM
3.If multiple issues are mentioned in the bug and if it fixed ONLY some issues , close this & open a new bug for the outstanding issue(s)
1.Only in case of (Cross check on second machine, before re-activating any messages.)
A. If it fails directly as per the Repro steps
B. If it causes major regressions
2. But try to provide any extra info than given in the bug for better understanding to the Dev/ PM
3.If multiple issues are mentioned in the bug and if it fixed ONLY some issues , close this & open a new bug for the outstanding issue(s)
Link for more info:
From
Subhash
