Two Years of Squash Merge (2019)

Re:Two Years of Squash Merge (2019) by lifeisstillgood on Friday April 30, 2021 @04:13PM (#26998699)

I think you are using got commit log as a form of documentation.

I half-agree. I don't agree devs should spend (much) time cleaning up their logs as opposed to actually writing docs (inline) that help the next person

I do agree that there is rarely a good (even half good) history of decisions. This is never the Jira / tickets kept outside of the system.

But it is also no good abusing the commit log as a form of ... journal. (I know that sounds silly but )

I think an actual journal / blog kept by the dev lead will be much more useful

[ Parent | on HN ]

Re:Two Years of Squash Merge (2019) by oftenwrong on Friday April 30, 2021 @06:25PM (#27000252)

There's definitely value in putting documentation where it will be seen. For developers, writing in a code comment or commit message is a good bet. If there's an issue, they'll be in the code, and they'll be in the commit log, and they'll see what you've written.

At times I've been asked to document things in a company wiki. Typically nobody reads it and it never gets updated when others make changes to the code.

[ Parent | on HN ]