• Serinus@lemmy.ml
    link
    fedilink
    English
    arrow-up
    8
    ·
    1 year ago

    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.

    • hugsducks@lemmy.world
      link
      fedilink
      English
      arrow-up
      8
      arrow-down
      1
      ·
      1 year ago

      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