4 ms·
A well-written commit message should explain "why", this may partially consist of linking to external things (bug tickets, whatever). Although it is probably im
by randomswede 5y ago
A well-written commit message should explain "why", this may partially consist of linking to external things (bug tickets, whatever). Although it is probably important to have enough of a "why" that the reviewer can make an informed decision if they need to go check the external reference or can continue with the review as-is.
I ended up writing https://github.com/vatine/sressays/blob/main/change-requests.md https://github.com/vatine/sressays/blob/main/change-requests... to try to clarify to myself what I thought a good change request ("PR", "CL", "CR", whatever you want to call them) needs.