3 ms·

Amen. Far too many announcements and readmes jump right into installation requirements and “we’ve fixed X, Y and Z” but never actually tell you what the thing i

Amen. Far too many announcements and readmes jump right into installation requirements and “we’ve fixed X, Y and Z” but never actually tell you what the thing is!

convalescindrey 3y ago
A changelog is supposed to tell you what has changed. A general greeting/landing page is supposed to tell you what the thing is. Trouble is if a link to a changelog is submitted to HN. Most people who don't know what the thing is click on it, have no clue what they are looking it, close it again and then downvote the submission. Submissions for not-widely-known stuff should be a landing page, not a changelog page. (In other words, this hurl page is kind of a mix between these two which is odd and arguably misusing what a changlog / news announcement page should be.)
- jicea 3y ago
  We've a more "classic" changelog in GitHub [1], I see the blog post as an editorial view of the changelog: highlights of main features/changes with some context. [1] https://github.com/Orange-OpenSource/hurl/releases/tag/4.0.0 https://github.com/Orange-OpenSource/hurl/releases/tag/4.0.0
- phist_mcgee 3y ago
  My favourite is landing on a github repo for a project and reads like the following: Schmaggle is the new hyperlayer to solve excess Flingles when re-routing Blumbles in non-zero p=np equations. Please open a PR if you're interested. Or something to that effect.
jpalomaki 3y ago
Happy to notice the "Locate the logo on top left corner and click" works in this case! I'm immediately forward to a page that provides exactly what I need.
bandrami 3y ago
What irks me is when the project description focuses on "Updog is written from scratch in Deactivated Typeflange" or whatever. So many github readme's where I have a pretty good idea about why the devs chose the language and toolchain they chose but zero idea of what the project does and why I might want to use it.

Amen. Far too many announcements and readmes jump right into installation requirements and “we’ve fixed X, Y and Z” but never actually tell you what the thing is!

convalescindrey 3y ago

A changelog is supposed to tell you what has changed. A general greeting/landing page is supposed to tell you what the thing is. Trouble is if a link to a changelog is submitted to HN. Most people who don't know what the thing is click on it, have no clue what they are looking it, close it again and then downvote the submission. Submissions for not-widely-known stuff should be a landing page, not a changelog page. (In other words, this hurl page is kind of a mix between these two which is odd and arguably misusing what a changlog / news announcement page should be.)

jicea 3y ago
We've a more "classic" changelog in GitHub [1], I see the blog post as an editorial view of the changelog: highlights of main features/changes with some context. [1] https://github.com/Orange-OpenSource/hurl/releases/tag/4.0.0 https://github.com/Orange-OpenSource/hurl/releases/tag/4.0.0
phist_mcgee 3y ago
My favourite is landing on a github repo for a project and reads like the following: Schmaggle is the new hyperlayer to solve excess Flingles when re-routing Blumbles in non-zero p=np equations. Please open a PR if you're interested. Or something to that effect.

jpalomaki 3y ago

Happy to notice the "Locate the logo on top left corner and click" works in this case! I'm immediately forward to a page that provides exactly what I need.

bandrami 3y ago

What irks me is when the project description focuses on "Updog is written from scratch in Deactivated Typeflange" or whatever. So many github readme's where I have a pretty good idea about why the devs chose the language and toolchain they chose but zero idea of what the project does and why I might want to use it.