search

purescript-contrib / purescript-vim

Syntax highlighting and indentation for PureScript
BSD 2-Clause "Simplified" License
154 stars 35 forks source link

Maintainer badge: toastal #89

Closed jamesdbrock closed 1 year ago

jamesdbrock commented 2 years ago

Can we put your maintainer badge on the readme?

toastal commented 1 year ago

Broader question: is there something that the image does that plaintext doesn't?

jamesdbrock commented 1 year ago

Broader question: is there something that the image does that plaintext doesn't?

It just makes it look fancy. Which I personally like.

toastal commented 1 year ago

Following the GNOME projects I've elected for a plaintext MAINTAINERS.txt (an example in GIMP: https://gitlab.gnome.org/GNOME/gimp/-/blob/master/MAINTAINERS) over a badge.

Reasoning:

  1. I disagree with the value of adding "fancy" things. From a visual design standpoint, it adds too much weight at this badge as it's both bold and has color. In checking out the new branch and viewing the render, I caught my eyes first reaching towards the badge; the primary target should be the title (I think this arms race might be another reason projects start adding logos to compete with the all of the other iconography).
  2. It's a dedicated file so it doesn't pollute the README (remember that everything in the README gets added to the helpfile). The more information in the README, the harder it is to parse, and this is especially true with non-essential images where the plaintext readability decays (it's not called RENDERME).
  3. A dedicated file actually gives room to give more contact info in case someone in the community needs to get a hold of the maintainer. What you don't want is issues raised just asking "is this still maintained?" and having no way to get that info.