Bug-fixing Checklist ?

[nelsonic]

Often I come across code in a "mature" codebase that I have no idea how it got there.

should we add a section on bug-fixing encouraging (requiring?) people to:

• add a code comment linking to a bug report in the code...?
• create a regression test with a clear and link to the github issue that unambiguously fixes the issue.

[iteles]

I really like the idea. The question is should this be for all bugs or only the code that is maybe a little out of place or we think new developers to the code wouldn't fully understand the thinking behind?

I can imagine that some code bases would be FULL of comments if this goes on over the course of a year or two. Not sure that's an issue.