search

jmespath-community / jmespath.spec

JMESPath Specification
6 stars 3 forks source link

Linter/Autoformatter for JEPs #33

Open innovate-invent opened 2 years ago

innovate-invent commented 2 years ago

I am finding the existing markdown files have line terminators that break markdowns autowrapping.

PRs should trigger a autoformatter and linter to ensure correct document structure.

springcomp commented 2 years ago

Are you talking about CRLF vs LF line endings ? I believe this can be applied at the repository level wit the core.crlf option.

innovate-invent commented 2 years ago

yea, I am aware of the git feature for line endings and that should be used for that purpose. I am also seeing typos and spelling errors throughout the JEPs and README that should be caught by a linter. The linter should also check for all required sections, section ordering, header table fields and values, consistent markdown formatting, etc.