#284 fix markdownlint violations in README.md - #290
Open
VasilevNStas wants to merge 1 commit into
Open
Conversation
PR zerocracy#246 rewrote README.md and introduced 10 markdownlint violations. Since its branch was created before the markdown-lint workflow had a pull_request trigger (zerocracy#240), the errors were never caught before merge. They block CI on every push to master. This PR fixes all 10 violations: adds language to code fence, normalises ordered list prefixes, fixes table column style, and wraps the wide table in an MD013 disable/enable block.
Contributor
Author
|
@yegor256 plz review this |
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
1 participant
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.
Problem
Every push to
masterfails themarkdown-lintworkflow with 10 errors. CI has been red since June 13.Root cause
PR #246 ("Rewrite README with full documentation and quick start guide") was created on June 8 — before the
markdown-lintworkflow had apull_requesttrigger (that was added by PR #240 on June 13). When #240 was merged, nobody pushed to #246's branch to re-trigger CI. GitHub Actions does not automatically re-run checks on open PRs when a new workflow lands on the base branch.Result: #246 was merged with 10 markdownlint violations, and they've blocked CI on every push to master since.
Timeline (June 13):
pull_requesttrigger added to markdown-lint workflowViolations fixed
```text2./3./4./5.→1.<!-- markdownlint-disable MD013 -->wrapping the tableLong‑term prevention
This scenario (open PR bypasses a new CI workflow on master) could have been avoided if the branch protection rules required
markdown-lintas a mandatory status check. Without that, any PR opened before a new workflow is added to the repo can slip through — even with thepull_requesttrigger now in place.Verification
Checklist
bundle exec rubocop— 0 offencesbundle exec rake— all tasks pass@yegor256 please review