Update README.md #31
Merged
Update README.md #31
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
👋 Hello and thanks for pinging us! An accessibility first responder will review this soon.
|
khiga8
commented
Dec 29, 2022
| In addition to defaults defined by `markdownlint`, we use this repository to enforce rules not defined by default, including our own custom rules. | ||
|
|
||
| See our opinions codified in [index.js](./index.js). | ||
|
|
||
| ### Should I disable rules enabled by this plugin? |
There was a problem hiding this comment.
Moving this down after the setup where it makes more sense.
khiga8
commented
Dec 29, 2022
|
|
||
| ## Opinions | ||
|
|
||
| At GitHub, we have opinions about how our markdown should be written. |
There was a problem hiding this comment.
This seemed redundant so removing.
khiga8
commented
Dec 29, 2022
Comment on lines
-3
to
-5
| We are using the [`markdownlint`](https://github.com/DavidAnson/markdownlint) library (via [`markdownlint-cli2`](https://github.com/DavidAnson/markdownlint-cli2) and adding our opinions and custom rules to it. | ||
|
|
||
| To review behaviors supported by `markdownlint`, particularly how to enable or disable rules, see [`markdownlint-cli2` configuration](https://github.com/DavidAnson/markdownlint-cli2#configuration). |
There was a problem hiding this comment.
I moved portions of this down into the setup section.
Co-authored-by: Lindsey Wild <35239154+lindseywild@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes: #29
Adds instructions for configuring formatter which will ensure error messages include link to rule documentation (which doesn't happen by default).
Also does minor clean-up.