top | item 38550103

(no title)

kunwon1 | 2 years ago

It seems to be getting more and more common to leave your git repository completely undocumented. If you're releasing a software project on github, I want to read about it on github.

A basic README that outlines what it does, how it does it, and basic syntax - this is really easy. Table stakes, I might say. I can checkout your repo and I have everything I need to work

discuss

order

zeeg|2 years ago

Don’t disagree, but technically the docs are in the same repo. Not easily consumed though.

We removed bits from the readme as it kept becoming duplicated and eventually wrong. I think that’s the usual reason folks like to avoid it. DRY and all.

1letterunixname|2 years ago

It's a terrible habit. Documentation is a nonfunctional requirement. It should describe what is not obvious to someone new and the value of it. Without the conveyance of utility and purpose, all of a project's potential value goes to waste with foot-gunning accuracy.

ren_engineer|2 years ago

a lot of "open source" companies leave their repos bare so you are forced to go onto their website where they can better track and retarget you

joshmanders|2 years ago

Retarget you for what? "Hey you should come back and read the docs on our open source project you were interested in last week"