Uh oh!
There was an error while loading. Please reload this page.
Add markdown style guide to CONTRIBUTING - #4027
Conversation
mikekistler
commented
Aug 15, 2024
We should add the rules for "property" vs "field" vs "keyword" in #4020 |
ralfhandl
left a comment
There was a problem hiding this comment.
+1, some suggestions inline
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Co-authored-by: Ralf Handl <ralf.handl@sap.com>
Co-authored-by: Ralf Handl <ralf.handl@sap.com>
lornajane
commented
Aug 15, 2024
In the TDC meeting we discussion that we should be using |
mikekistler
commented
Aug 20, 2024
Can I merge an "editorial" PR with just one approval? |
ralfhandl
commented
Aug 20, 2024
Unfortunately we haven't yet resolved |
ralfhandl
commented
Aug 20, 2024
Btw., I forgot that you want to add .markdownlint.yaml in this PR in the project root. In PRs #4040, #4041, and #4025 I add it in the Would you mind to update this PR and npm i -D markdownlint-cliso that we have the tool to interpret .markdownlint.yaml as a dev dependency? |
ralfhandl
commented
Aug 20, 2024
Resolved conflict in package.json, refreshed package-lock.json |
handrews
commented
Aug 20, 2024
@mikekistler I was intending to actually look over this by Thursday, but I have no objection to you merging it as we can always tweak it later. |
ralfhandl
commented
Aug 22, 2024
Refreshed package-lock.json due to action errors in my fork |
This PR adds a Markdown style guide to the CONTRIBUTING.md. I've lifted the bullets from @ralfhandl 's PRs on style fixup and added the .markdownlint.yaml file from @lornajane 's PRs for markdown updates.
There may be other things to add but I think this is a pretty good start and since we are already acting on these I thought we should make sure we have consensus and then capture that in the docs.