Timeline for Should I submit a pull request to correct minor typos in a Readme file?
Current License: CC BY-SA 4.0
8 events
| when toggle format | what | by | license | comment | |
|---|---|---|---|---|---|
| Nov 17, 2020 at 21:44 | comment | added | Ben | I agree that good comments in the code are helpful, and can even explain why something is the way it is for a small grouped code change. But when a code change is spread across several files, the developer isn't going to comment every change. Too many comments in the code is just as bad as none. | |
| Nov 17, 2020 at 21:07 | review | Low quality posts | |||
| Nov 18, 2020 at 11:06 | |||||
| Nov 17, 2020 at 17:37 | comment | added | Asteroids With Wings | softwareengineering.stackexchange.com/questions/411585/… | |
| Nov 17, 2020 at 17:36 | comment | added | Asteroids With Wings | Or if they'd explained it with some simple code comments, as I suggested. | |
| Nov 17, 2020 at 17:06 | comment | added | Ben | What you did is apparent from the code, but not Why. Why did you feel that change was necessary. I've spent a lot of time looking at old code trying to figure out what they were thinking. If only they were still around to explain why that did what they did, then maybe it would make sense. | |
| Nov 17, 2020 at 16:39 | comment | added | Asteroids With Wings | "Why" should be clear from the code too. If it isn't clear from the actual instructions, there need to be comments. If the reason for the change is only apparent from the commit message, that's bad. The commit message is great for looking up prior changes though. | |
| Nov 17, 2020 at 14:18 | review | First posts | |||
| Nov 19, 2020 at 13:42 | |||||
| Nov 17, 2020 at 14:13 | history | answered | Ben | CC BY-SA 4.0 |