-
-
Notifications
You must be signed in to change notification settings - Fork 307
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
checks: exclude README.md from markdown-lint in pre-commit-config.yaml #2971
Conversation
markdown-lint: exclude README.md from 033-no-inline-html.md, i.e. allow inline HTML in README.md. Addresses OSGeo#2947 (comment)
If this fixes the README, why exclude it? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
With the suggested changes the Markdown is valid and no need to exclude the file from validation.
Co-authored-by: Nicklas Larsson <n_larsson@yahoo.com>
It didn't, that's why. |
Co-authored-by: Nicklas Larsson <n_larsson@yahoo.com>
Thanks @nilason, now it looks good. |
(It may be merged as soon as the DNS DOS on osgeo.org stops and the CI comes back to life - or we implement a fallback sample data download using the fatra server) |
* pre-commit-config.yaml: exclude README.md from markdown-lint markdown-lint: exclude README.md from 033-no-inline-html.md, i.e. allow inline HTML in README.md. Addresses #2947 (comment) Co-authored-by: Nicklas Larsson <n_larsson@yahoo.com>
Seeing this and other commits on 8.3 branch, there is no need to include file names or even paths in the commit message (and especially in its first line as a prefix). These things are part of the commit itself as the general submitting guidelines discuss. While not automatically enforced, we do have a list prefixes for commit messages in utils/release.yml. When the known prefixes are used, things like Oh, wait, now I see that the file in the commit message was not even changed by the commit... 😭 |
) * pre-commit-config.yaml: exclude README.md from markdown-lint markdown-lint: exclude README.md from 033-no-inline-html.md, i.e. allow inline HTML in README.md. Addresses OSGeo#2947 (comment) Co-authored-by: Nicklas Larsson <n_larsson@yahoo.com>
markdown-lint: exclude README.md from 033-no-inline-html.md, i.e. allow inline HTML in README.md.
Addresses
#2947 (comment)