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

auto-format core markdown files (e.g. readme) #8603

Merged
merged 1 commit into from
Jun 1, 2022

Conversation

lb-
Copy link
Member

@lb- lb- commented May 26, 2022

  • clean up formatting on existing markdown files to align with prettier
  • this creates a few diffs but it means that we have consistently formatted files for future changes to these root markdown files

@squash-labs
Copy link

squash-labs bot commented May 26, 2022

Manage this branch in Squash

Test this branch here: https://lb-cleanupcore-markdown-files-gjn7o.squash.io

- clean up formatting on existing martkdown files to align with prettier
@lb- lb- force-pushed the cleanup/core-markdown-files-formatting branch from aa44350 to 1338e62 Compare June 1, 2022 08:00
Copy link
Contributor

@zerolab zerolab left a comment

Choose a reason for hiding this comment

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

The changes LGTM.
Will the next step be to lint .md with prettier in pre-commit? https://github.com/wagtail/wagtail/blob/main/.pre-commit-config.yaml#L28

@lb-
Copy link
Member Author

lb- commented Jun 1, 2022

The changes LGTM. Will the next step be to lint .md with prettier in pre-commit? https://github.com/wagtail/wagtail/blob/main/.pre-commit-config.yaml#L28

Not at the moment. My understanding is that we want to avoid too much friction for small markdown changes to be submitted via GitHub UI online.

However, I think at some point we will find it beneficial to adopt prettier for markdown also.

@thibaudcolas may have more input here.

@lb- lb- merged commit 0012c34 into wagtail:main Jun 1, 2022
@lb- lb- deleted the cleanup/core-markdown-files-formatting branch June 1, 2022 13:09
@lb-
Copy link
Member Author

lb- commented Jun 1, 2022

Thanks @zerolab

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants