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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CI: add mdformat #8673

Merged
merged 6 commits into from
Aug 3, 2021
Merged

CI: add mdformat #8673

merged 6 commits into from
Aug 3, 2021

Conversation

Borda
Copy link
Member

@Borda Borda commented Aug 2, 2021

What does this PR do?

use MarkDown formatted, shall prevent eventual rending issues
no content changes...

Does your PR introduce any breaking changes? If yes, please list them.

Before submitting

  • Was this discussed/approved via a GitHub issue? (not for typos and docs)
  • Did you read the contributor guideline, Pull Request section?
  • Did you make sure your PR does only one thing, instead of bundling different changes together?
  • Did you make sure to update the documentation with your changes? (if necessary)
  • Did you write any new necessary tests? (not for typos and docs)
  • Did you verify new and existing tests pass locally with your changes?
  • Did you list all the breaking changes introduced by this pull request?
  • Did you update the CHANGELOG? (not for typos, docs, test updates, or internal minor changes/refactorings)

PR review

Anyone in the community is welcome to review the PR.
Before you start reviewing make sure you have read Review guidelines. In short, see the following bullet-list:

  • Is this pull request ready for review? (if not, please submit in draft mode)
  • Check that all items from Before submitting are resolved
  • Make sure the title is self-explanatory and the description concisely explains the PR
  • Add labels and milestones (and optionally projects) to the PR so it can be classified

Did you have fun?

Make sure you had fun coding 🙃

@codecov
Copy link

codecov bot commented Aug 2, 2021

Codecov Report

Merging #8673 (2944dad) into master (49d03f8) will not change coverage.
The diff coverage is n/a.

@@          Coverage Diff           @@
##           master   #8673   +/-   ##
======================================
  Coverage      89%     89%           
======================================
  Files         167     167           
  Lines       14037   14037           
======================================
  Hits        12453   12453           
  Misses       1584    1584           

Copy link
Contributor

@awaelchli awaelchli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

something is going wrong with enumerated lists

pl_examples/basic_examples/README.md Show resolved Hide resolved
@Borda
Copy link
Member Author

Borda commented Aug 2, 2021

something is going wrong with enumerated lists

see https://guides.github.com/features/mastering-markdown/

@Borda Borda requested a review from awaelchli August 2, 2021 08:39
CHANGELOG.md Outdated Show resolved Hide resolved
@Borda
Copy link
Member Author

Borda commented Aug 2, 2021

failing for hukkin/mdformat#247

Copy link
Member

@ethanwharris ethanwharris left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

.github/CONTRIBUTING.md Outdated Show resolved Hide resolved
.github/CONTRIBUTING.md Outdated Show resolved Hide resolved
@Borda Borda enabled auto-merge (squash) August 2, 2021 13:18
@mergify mergify bot added the ready PRs ready to be merged label Aug 2, 2021
Copy link
Contributor

@tchaton tchaton left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM !

Borda and others added 3 commits August 3, 2021 19:41
Co-authored-by: Carlos Mocholí <carlossmocholi@gmail.com>
@Borda Borda merged commit 0e6ee9c into master Aug 3, 2021
@Borda Borda deleted the refactor/md branch August 3, 2021 18:19
SeanNaren pushed a commit that referenced this pull request Aug 10, 2021
* add mdformat
* exclude chlog
* fix ***

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Carlos Mocholí <carlossmocholi@gmail.com>

(cherry picked from commit 0e6ee9c)
lexierule pushed a commit that referenced this pull request Aug 11, 2021
* add mdformat
* exclude chlog
* fix ***

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Carlos Mocholí <carlossmocholi@gmail.com>

(cherry picked from commit 0e6ee9c)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ready PRs ready to be merged refactor
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants