-
-
Notifications
You must be signed in to change notification settings - Fork 37
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
Add remark configuration #122
Conversation
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.
Good addition.
- Should some information be added to the
CONTRIBUTING
file to document that markdown is expected to conform to the Remark rules ? - Should some information be added to the
CONTRIBUTING
file on how to locally install and run this check ? - If the above would suggest installation in a project local manner - are there files which should be added to the
.gitignore
file ?
A quick search yielded me these as relevant links:
Good points. I've been thinking about that as well. Not just for Remark, but regarding the other GitHub actions we run... There seems to be a lot of implicit knowledge assumed, which is a bad sign. I've created a separate issue for documenting how to run all of the QA tools in our current pipeline and continue this conversation there: #123 |
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.
Approving under the understanding that "how to run the tooling" will be documented in a separate PR.
Merging without re-review as there are no new changes, just a rebase of already reviewed changes. |
Proposed Changes
This MR adds a configuration file for Remark, so there is now one consistent way Markdown should be written in this repo.
The configuration uses the
lint-recommended
preset, with as only exception that thelist-item-indent
has been set to only require a single space after a list character (as opposed to the multi-space default).Other than a few links in the README, all markdown files in the repo already adhere to this standard.
As there is already a GitHub action that runs Remark, no other changes are needed.
Related Issues
This MR is inspired by the comment from @jrfnl in #118 regarding inconsistencies in my Markdown.
I suggested adding a Remark config, so here it is! 😁