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

Comply with Markdownlint standards #4

Open
jmcdo29 opened this issue Aug 1, 2019 · 1 comment
Open

Comply with Markdownlint standards #4

jmcdo29 opened this issue Aug 1, 2019 · 1 comment
Labels
enhancement New feature or request

Comments

@jmcdo29
Copy link

jmcdo29 commented Aug 1, 2019

Is your feature request related to a problem? Please describe.
Not necessarily a problem, but it is a minor annoyance when I open a README in my editor and see a lot of warnings about how the markdown doesn't adhere to linting standards.

Describe the solution you'd like
Update the templates to comply with linting standards so that one creation there are no warnings :)

Describe alternatives you've considered
One alt is just to have the developer update the readme themselves if they really are bothered so much by the warnings, but wouldn't it be nice if there were no warnings to begin with?

I'm more than happy to submit a PR that is just an update to the templates and other .md files to comply with linting standards. If this doesn't seem like something you want to follow either, feel free to close the issue.

@luctst luctst added the enhancement New feature or request label Aug 2, 2019
@luctst
Copy link
Owner

luctst commented Aug 2, 2019

Hey @jmcdo29 👋

Thank's for your issue i agree with you i think it can be a great idea to follow the standards I will find out a little more about markdownlint and see what I can do with.

Thank's 🙂

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

No branches or pull requests

2 participants