this post was submitted on 01 Oct 2023
511 points (98.5% liked)
Jellyfin: The Free Software Media System
5476 readers
42 users here now
Current stable release: 10.9.7
Matrix (General Information & Help)
Matrix (Off-Topic) - Come get to know the team and blow off steam!
Matrix Space - List of all the available rooms on Matrix.
Discord - Bridged to our Matrix rooms
founded 4 years ago
MODERATORS
you are viewing a single comment's thread
view the rest of the comments
view the rest of the comments
Documentation tends to be "you take what you can get" on both sides. Are you going to turn down a PR because there aren't supporting docs? That's a good way to drive off developers too.
Generally someone who is annoyed with having to figure it out is the one who writes the documentation.
I personally completely require documentation. Adding a feature may be beneficial in the short term, but not documenting it can create increasing maintenance burden in the long term. Every PR merged without docs slowly kills a project, even if it feels like it's better to merge initially. When this is repeated too many times, the project becomes increasingly difficult to maintain. Merging only PRs with docs is how you prevent a project from dying. Even the original author of the code will eventually forget why they chose to do something a certain way or what edge case they were covering at the time