Add remark configuration#122
Merged
Potherca merged 2 commits intoPHPCSStandards:masterfrom Nov 25, 2020
Merged
Conversation
jrfnl
reviewed
Nov 23, 2020
Member
jrfnl
left a comment
There was a problem hiding this comment.
Good addition.
- Should some information be added to the
CONTRIBUTINGfile to document that markdown is expected to conform to the Remark rules ? - Should some information be added to the
CONTRIBUTINGfile 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
.gitignorefile ?
A quick search yielded me these as relevant links:
Member
Author
|
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 |
4 tasks
jrfnl
approved these changes
Nov 24, 2020
jrfnl
previously approved these changes
Nov 24, 2020
Member
jrfnl
left a comment
There was a problem hiding this comment.
Approving under the understanding that "how to run the tooling" will be documented in a separate PR.
Member
Author
|
Merging without re-review as there are no new changes, just a rebase of already reviewed changes. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
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-recommendedpreset, with as only exception that thelist-item-indenthas 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! 😁