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

Conversation

@deivid-rodriguez
Copy link
Contributor

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

This comment has been minimized.

Copy link

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

left a comment

Suuuper nice! Didn't know this existed!

@josepjaume josepjaume merged commit e8ea0a5 into master Nov 6, 2017
31 checks passed
31 checks passed
ci/circleci: accountability Your tests passed on CircleCI!
Details
ci/circleci: admin Your tests passed on CircleCI!
Details
ci/circleci: api Your tests passed on CircleCI!
Details
ci/circleci: assemblies Your tests passed on CircleCI!
Details
ci/circleci: budgets Your tests passed on CircleCI!
Details
ci/circleci: build Your tests passed on CircleCI!
Details
ci/circleci: comments Your tests passed on CircleCI!
Details
ci/circleci: core Your tests passed on CircleCI!
Details
ci/circleci: main Your tests passed on CircleCI!
Details
ci/circleci: meetings Your tests passed on CircleCI!
Details
ci/circleci: pages Your tests passed on CircleCI!
Details
ci/circleci: processes Your tests passed on CircleCI!
Details
ci/circleci: proposals Your tests passed on CircleCI!
Details
ci/circleci: surveys Your tests passed on CircleCI!
Details
ci/circleci: system Your tests passed on CircleCI!
Details
codeclimate All good!
Details
codecov/patch Coverage not affected when comparing b407dd2...29ed1a5
Details
codecov/project 98.55% remains the same compared to b407dd2
Details
codecov/project/accountability 100% remains the same compared to b407dd2
Details
codecov/project/admin 100% remains the same compared to b407dd2
Details
codecov/project/api 100% remains the same compared to b407dd2
Details
codecov/project/assemblies 100% remains the same compared to b407dd2
Details
codecov/project/budgets 100% remains the same compared to b407dd2
Details
codecov/project/comments 100% remains the same compared to b407dd2
Details
codecov/project/core 100% remains the same compared to b407dd2
Details
codecov/project/meetings 100% remains the same compared to b407dd2
Details
codecov/project/pages 100% remains the same compared to b407dd2
Details
codecov/project/processes 100% remains the same compared to b407dd2
Details
codecov/project/proposals 100% remains the same compared to b407dd2
Details
codecov/project/surveys 100% remains the same compared to b407dd2
Details
codecov/project/system 100% remains the same compared to b407dd2
Details
@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
Projects
None yet
2 participants
You can鈥檛 perform that action at this time.