search

dimo414 / ProfileGem

A shell configuration utility to compartmentalize and manage your terminal utilities and environment
GNU General Public License v3.0
22 stars 6 forks source link

Run mdformat on markdown files #27

Closed SUPERCILEX closed 4 years ago

dimo414 commented 4 years ago

Thanks, but I think I'll leave this as-is for now; without a regularly running linter or CI ensuring proper formatting is a manual chore. Of course if you feel like getting mdformat running as a check in ci.yml I'd welcome that :)

SUPERCILEX commented 4 years ago

While I agree that this won't last long-term, I still think it's a bummer to reject these changes simply on the basis of, "since it will get bad in the future, there's no point in making it better now." I sadly can't set up CI since this is using go/mdformat.

On a related note, I would like to push back on this change specifically: Googlers get a copy of template/README.md when they create a gem, but the markdown linter currently yells at you when trying to submit that file. Sure, it's just a warning, but it would be nice to have a clean CL by default.

dimo414 commented 4 years ago

Let's keep discussions about Google-specific issues internal, please. If you file a bug internally we can identify a proper resolution. But if your motivation for this PR is to address lint errors in another system that reinforces the need for CI here; otherwise regressions are inevitable.