Ancestors

Written by Katie Sylor-Miller on 2024-09-20 at 10:59

Once again I am imploring you to comment your code to make it clear why you do something. I promise you that your code will never be “self documenting” enough for anyone outside of your team to understand it if it has ZERO comments to explain shit

=> More informations about this toot | More toots from ksylor@front-end.social

Toot

Written by Katie Sylor-Miller on 2024-09-20 at 11:05

Especially especially especially comment the shit out of things if you run a large open source platform, help us help you by making it possible to understand the deep internals of your code. Sorry but I don’t have hours and hours to “just read the tests” or “just look at git history”

=> More informations about this toot | More toots from ksylor@front-end.social

Descendants

Written by 0xC0DEC0DE07E9 on 2024-09-20 at 12:08

@ksylor “just read [my other uncommented] project] the uses that library to get a feel for how it works”

=> More informations about this toot | More toots from c0dec0dec0de@hachyderm.io

Written by 0xC0DEC0DE07E9 on 2024-09-20 at 12:09

@ksylor or the got history that includes insights like “Fix things” and “Make tests green, for real this time”

=> More informations about this toot | More toots from c0dec0dec0de@hachyderm.io

Written by Katie Sylor-Miller on 2024-09-20 at 12:20

@c0dec0dec0de oh yeah the Venn diagram of “no comments in code” and “shitty commit messages” is a circle

=> More informations about this toot | More toots from ksylor@front-end.social

Written by Katie Sylor-Miller on 2024-09-20 at 12:20

@c0dec0dec0de lmao yeah that’s almost worse because they clearly know that their docs are lacking but they won’t do anything about it

=> More informations about this toot | More toots from ksylor@front-end.social

Written by RevK :verified_r: on 2024-09-20 at 13:53

@ksylor One of the biggest reasons for good comments is self interest - telling "future you" WTF you were on at the time.

=> More informations about this toot | More toots from revk@toot.me.uk

Written by Nathan Knowler on 2024-09-20 at 14:09

@ksylor omg this. I work with a company where lots of work is done on forks in various GH orgs and after we merge with upstream, repos can be reset, so we lose all of the PR descriptions and discussion. Code is the only place that relevant knowledge can be persisted.

=> More informations about this toot | More toots from knowler@sunny.garden

Written by Katie Sylor-Miller on 2024-09-20 at 14:12

@knowler oh geeeez

=> More informations about this toot | More toots from ksylor@front-end.social