search

os-climate / OS-Climate-Community-Hub

START HERE: OS-Climate Community & Project Collaboration Space
Apache License 2.0
103 stars 18 forks source link

Update README.md #144

Closed strawberry-baked-alaska closed 5 months ago

strawberry-baked-alaska commented 8 months ago

@MichaelTiemannOSC or @ModeSevenIndustrialSolutions - do you know why the pre commit failed? Can either of you help approve this PR? I have additional updates I need to make to the Readme, but want to make sure this is merged first. Thanks!

MichaelTiemannOSC commented 8 months ago

These are the reported errors:

.github/ISSUE_TEMPLATE/request-credentials-for-an-os-climate-bucket.md:9:41 MD033/no-inline-html Inline HTML [Element: github-user-name]
.github/ISSUE_TEMPLATE/request-credentials-for-an-os-climate-bucket.md:11:40 MD033/no-inline-html Inline HTML [Element: bucket-name]
.github/ISSUE_TEMPLATE/request-credentials-for-an-os-climate-bucket.md:13:51 MD033/no-inline-html Inline HTML [Element: email-address]
.github/ISSUE_TEMPLATE/request-onboarding-to-osc-data-commons.md:9:40 MD033/no-inline-html Inline HTML [Element: github-user-name]
CONTRIBUTING.md:85:1 MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 4; Style: 1/1/1]

I think the original author was not trying to write inline html, but <github-user-name> is parsed that way without stronger quotes. Perhaps the fix is to simply use code quotes around the offending elements. As for the last error, that just looks like a list consistency problem. Here's a stack overflow answer to that problem: https://stackoverflow.com/questions/18088955/markdown-continue-numbered-list/36337068#36337068

ModeSevenIndustrialSolutions commented 5 months ago

Apologies if I missed this - probably needed somebody to ping me on Slack or by email.

Indeed, people were using brackets of the type <> to designate placeholder content that should be substituted, but in markdown this is interpreted as inline HTML, and is against the specification, hence the merge being blocked on pre-commit. Converting the text to [] problems has resolved this. I sorted this on a subsequent PR, then rebased this change and merged it.