Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Linter/Autoformatter for JEPs #33

Open
innovate-invent opened this issue Mar 4, 2022 · 2 comments
Open

Linter/Autoformatter for JEPs #33

innovate-invent opened this issue Mar 4, 2022 · 2 comments

Comments

@innovate-invent
Copy link
Collaborator

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
Copy link
Contributor

springcomp commented Mar 4, 2022

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
Copy link
Collaborator Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants