Short Text Note

2024-09-26 14:41:23 UTC

New blog post: https://harihareswara.net/posts/2024/changelogs-and-release-notes/

- The distinction between detailed changelogs and brief release notes (with examples)

- Why it's worth doing both

- Why relying solely on GitHub as a project's communication platform discourages publishing and reading release notes

Spurred by [@nedbat](https://hachyderm.io/@nedbat ) 's https://hachyderm.io/@nedbat/113152493265812268 , with references to [@wiredferret](https://hachyderm.io/@wiredferret ) Karl Fogel (npub10r8…gh0u) Leonard Richardson (npub14hs…swac) Aurélien Gâteau (npub1saa…xm6g) olivierlacan (npub19yk…vv0j) David Brownman (npub1yx9…zzja) [@zwol](https://hackers.town/@zwol ) Zulip (npub1qfg…mum6) and more.

#maintainers #opensource #FLOSS #maintainership #documentation

Author Public Key

npub1hv5x9ks4guwsvp4e2zg50qsu9kqsnjgsygngr7ams9j2j76jlw9s6zxq0v

Seen on

wss://relay.momostr.pink

Show more details

Published at

2024-09-26 14:41:23 UTC

Kind type

1 Short Text Note

Event JSON

{ "id": "5ebf36d7f51ec2c89c80c97d3aa770f62dd260c2384dc526bd1d1b84c799aa4b", "pubkey": "bb2862da15471d0606b9509147821c2d8109c910222681fbbb8164a97b52fb8b", "created_at": 1727361683, "kind": 1, "tags": [ [ "proxy", "https://social.coop/@brainwane/113204375287779961", "web" ], [ "t", "opensource" ], [ "t", "maintainership" ], [ "t", "documentation" ], [ "p", "02514f6473d28c2728249708ee881e7b6a58b64d369015052988c5b4b4a363f9" ], [ "p", "78ceebb45ef1c117b4c8ec9eefd3ba32f030e2f8f24162a52067cf903320ded4" ], [ "t", "maintainers" ], [ "p", "ade1bb6a5ecce95bda3161a713ec7cfe602c10af1fb497b004cbc307fe125087" ], [ "p", "292c67d5f8ac9b52dfda39e54bbbc0eab55311689c5be26c57e749b861c2ece6" ], [ "t", "floss" ], [ "p", "218b50e075d59f05a2be45ed72165dde579c7b4d8e716c733665ac37b719b2ad" ], [ "p", "877b53f8e4cd2e1f8b4b6d023cfc2b93a30a9cb66c187967acc04ffe2121bd9a" ], [ "proxy", "https://social.coop/users/brainwane/statuses/113204375287779961", "activitypub" ], [ "L", "pink.momostr" ], [ "l", "pink.momostr.activitypub:https://social.coop/users/brainwane/statuses/113204375287779961", "pink.momostr" ], [ "-" ] ], "content": "New blog post: https://harihareswara.net/posts/2024/changelogs-and-release-notes/\n\n- The distinction between detailed changelogs and brief release notes (with examples)\n\n- Why it's worth doing both\n\n- Why relying solely on GitHub as a project's communication platform discourages publishing and reading release notes\n\nSpurred by [@nedbat](https://hachyderm.io/@nedbat ) 's https://hachyderm.io/@nedbat/113152493265812268 , with references to [@wiredferret](https://hachyderm.io/@wiredferret ) nostr:npub10r8whdz778q30dxgaj0wl5a6xtcrpchc7fqk9ffqvl8eqveqmm2q45gh0u nostr:npub14hsmk6j7en54hk33vxn38mruleszcy90r76f0vqye0ps0lsj2zrsdkswac nostr:npub1saa4878ye5hplz6td5prelptjw3s489kdsv8jeavcp8lugfphkdqdcxm6g nostr:npub19ykx040c4jd49h7688j5hw7qa264xytgn3d7ymzhuaymscwzannqshvv0j nostr:npub1yx94pcr46k0stg47ghkhy9jametec76d3eckcuekvkkr0dcek2ksfwzzja [@zwol](https://hackers.town/@zwol ) nostr:npub1qfg57ern62xzw2pyjuywazq70d493djdx6gp2pff3rzmfd9rv0usnqmum6 and more.\n \n#maintainers #opensource #FLOSS #maintainership #documentation", "sig": "4e0917b580f2aca092dd61a72ce0e2fd49917e4cbcda62087edf60fd724f80fcebcbbafd1ed26f7295b48778592676767468f0318c38ceca3e206c0134eb5d48" }

Sumana Harihareswara on Nostr: New blog post: - The distinction between detailed changelogs and brief release notes ...