search

pyOpenSci / pyosMeta

A package that updates pyOpenSci contributor and package metadata on our website
BSD 3-Clause "New" or "Revised" License
4 stars 18 forks source link

Review settings for Codacy linting service #80

Closed willingc closed 7 months ago

willingc commented 10 months ago

The Codacy linter seems to be providing conflicting guidance on validity of Markdown style.

Let's review that it is checking correctly and that the style used matches our desired style.

lwasser commented 10 months ago

Sure thing. you know i used codacy a very long time ago and remember it being useful. BUT i also remember we added a config file to ensure it aligned with our goals. we could either decide it's not the right tool for us OR that we want to turn off markdown linting (the things it flagged seem a bit odd).

lwasser commented 10 months ago

i found this pre-commit hook and tested it out locally. it looks for things like duplicate headers, line length and missing language notations on code brackets in addition to list spacing, etc.

i'm not sure if it will make codacy happy or not but we could use a linter like this to enforce markdown syntax and tell codacy to ignore markdown as one option.

willingc commented 7 months ago

Since this seems to no longer be an issue, I'm closing this.