A good Best-Practice document summarised per discussion with Mike Thompson, the best engineer I’ve ever worked with in EMC.
What are the good practices when you write bug/feature description or bug/feature comments?
- Write for your audience. Think about wording from the reader’s point of view.
- Write for the future. Think about any current context that is needed to understand the words.
- Post summaries of offline discussion, instead of discussion itself (email, IM log etc.).
What we should pay attention to during the initial triage?
- Are there too many problems described? One problem, one ticket.
- Is support material (Steps to reproduce, Screenshot, Log etc.) available? If yes, make a quick analysis.
- Is this an obvious duplicate/regression?
- Validate/Clarify steps to reproduce.
What shall we consider before we start extensive code change?
- Make a review of our root cause analysis.
- Make a review of our solution design.
During code review, what are the 2 questions that reviewers should keep on asking themselves?
- Why. Why this solution? Why this code? Etc.
- Why not. Why not that solution? Why not that code? Etc.
What we should pay attention to when reviewing the problem solution?
- The problem is analyzed correctly. The real defect is found.
- The solution is correct & best for this problem, among other solutions.
- The solution is correctly implemented. No code error.
- If the problem is a regression, the regression causing bug/feature should be identified, and that bug/feature’s fix should not be breaked.
Root cause should be described precisely. What are the good practices for root cause description?
- Identify any pre-conditions required for the defect.
- Identify what is the expected outcome and what is the actual result.
- Describe why is the actual result. Write for the audience and write for the future.
- Identify when the defect is introduced into the system, especially if it is a regression.
If there is one problem, we know how the symptom is produced, and our code change can prevent the symptom, is that good enough? Why
No, creating an effective bug fix requires correctly identifying when the defect was introduced, and why it was introduced. Investigating on the code history and get the reason of regression is very important; it may influence the solution design.