-
Notifications
You must be signed in to change notification settings - Fork 9.1k
Add markdown style guide to CONTRIBUTING #4027
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
Conversation
We should add the rules for "property" vs "field" vs "keyword" in #4020 |
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.
+1, some suggestions inline
Co-authored-by: Ralf Handl <[email protected]>
Co-authored-by: Ralf Handl <[email protected]>
In the TDC meeting we discussion that we should be using |
Can I merge an "editorial" PR with just one approval? |
Unfortunately we haven't yet resolved |
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-cli so that we have the tool to interpret .markdownlint.yaml as a dev dependency? |
Resolved conflict in package.json, refreshed package-lock.json |
@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. |
Refreshed package-lock.json due to action errors in my fork |
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.
Thanks!
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.