big +1. ----------------------------------- Xiangdong Huang School of Software, Tsinghua University
黄向东 清华大学 软件学院 JT <[email protected]> 于2020年3月6日周五 下午5:20写道: > Hello guys, > > I have been working on weekly PR reports for several months, and I have to > say some PRs are just too brief for someone to understand what is going on. > I may have to read the code changes carefully to find out, but I certainly > do not have that time. > > So could you please use more specific titles and descriptions in the PRs > so it would be easier for other people to understand your work. Here are > some questions to answer that would help you make the PR more > understandable: > 1. What is the symptom of the bug > 2. What causes the bug > 3. Which module/package/class does the bug involve > 4. Why there is a performance issue > 5. How do you find it out > 6. How do you fix it > 7. What are the code quality issues (why is not the old code okay, just > name some) > 8. What is the performance improvement if your goal is to improve it > > Many thanks, > > Tian Jiang >
