OSS projects suggesting newbies contribute docs and tests is common, usually only because the author doesn’t want to do it themselves Writing a good test suite or coherent docs is work that requires a huge amount of project context, often much harder than contributing features
-
i’ve really been fascinated by the description of the amok documentation linking tool
@propensive discussed at the most recent scale by the bay which seems like it leans toward the more extreme separation end with a separate docs and/or tests repo
I wish I had had more time to work on it (note: just because I'm quarantined, I don't have any extra time!), but I'm strongly in the "separate repos" camp.
-
-
In short, I think that documentation should evolve independently of code, because you learn so much more about code long after it's published. We should be detailing bugs and other learned details against the range of historical versions to which they apply.
-
But I also think it needs specialised tooling.
- Show replies
New conversation -
Loading seems to be taking a while.
Twitter may be over capacity or experiencing a momentary hiccup. Try again or visit Twitter Status for more information.