awesome-nix icon indicating copy to clipboard operation
awesome-nix copied to clipboard

Published 20 hours ago • verified publisher icon nix-community

summaries should should be factual

Open fricklerhandwerk opened this issue 3 years ago • 1 comments

many summaries currently contain either value judgement ("simple", "awesome", "quickly", "better") or nondescript statements ("Beat your package expressions into a shape").

that does not help readers figure out how and why a recommendation may be useful to them.

summaries should consistently and factually state for every resource

  • what it is for
  • why it is part of this collection
  • (optional) how it differs from competing offers, trade-offs, etc.

related: https://github.com/nix-community/awesome-nix/issues/123

fricklerhandwerk avatar Aug 11 '22 01:08 fricklerhandwerk

Given the official comment guidelines, I'm inclined to agree.

Might even be good to phrase them in a manner like agile "user stories":

A [tool that does thing with special attribute] so that [benefit to user].

cyntheticfox avatar Aug 13 '22 14:08 cyntheticfox