Skip to content
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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Lint markdown #2158

Merged
merged 1 commit into from Nov 6, 2017
Merged

Lint markdown #2158

merged 1 commit into from Nov 6, 2017

Conversation

@deivid-rodriguez
Copy link
Contributor

@deivid-rodriguez deivid-rodriguez commented Nov 3, 2017

馃帺 What? Why?

Follow up #2148. It enforces in general what @xabier fixed in that PR for CONTRIBUTING.md, but also enforces other stuff like:

  • Consistent symbols (- or *) for lists.
  • Blank lines around code blocks, lists and headers (helps editors do their highlighting job).
  • No $ signs on terminal commands (helps with copy-pasting them).
  • ...

I've just started with the easiest rules, and with README.md and CONTRIBUTING.md for now. But we can tweak further later.

@decidim/developers What do you think about this? Some people arg that it's overkill to lint markdown. I think it's another part of software where linting can be useful...

馃搶 Related Issues

馃搵 Subtasks

None.

馃摲 Screenshots (optional)

None.

馃懟 GIF

tiger small

@ghost ghost assigned deivid-rodriguez Nov 3, 2017
@ghost ghost added the in-progress label Nov 3, 2017
@deivid-rodriguez deivid-rodriguez changed the title Lint markdownlint Lint markdown Nov 3, 2017
@deivid-rodriguez deivid-rodriguez force-pushed the feature/lint_markdown branch from 2f2fe17 to 29ed1a5 Nov 3, 2017
@codecov
Copy link

@codecov codecov bot commented Nov 4, 2017

Codecov Report

Merging #2158 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #2158   +/-   ##
=======================================
  Coverage   98.55%   98.55%           
=======================================
  Files        1180     1180           
  Lines       27047    27047           
=======================================
  Hits        26655    26655           
  Misses        392      392

Copy link
Contributor

@josepjaume josepjaume left a comment

Suuuper nice! Didn't know this existed!

@josepjaume josepjaume merged commit e8ea0a5 into master Nov 6, 2017
31 checks passed
@josepjaume josepjaume deleted the feature/lint_markdown branch Nov 6, 2017
@ghost ghost removed the in-progress label Nov 6, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants