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.

Sign up for GitHub

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

Jump to bottom

Add a pre-commit hook to format the Markdown files #147

Open
jhlegarreta opened this issue Apr 22, 2021 · 1 comment
Open

Add a pre-commit hook to format the Markdown files #147

jhlegarreta opened this issue Apr 22, 2021 · 1 comment
Labels
good first issue Good issue for first-time contributors type:formatting Formatting needs to be fixed

Comments

@jhlegarreta
Copy link
Contributor

Adding a pre-commit hook that is able to ensure that the Markdown files have a consistent format and follow the carpentries style would be a great addition and would allow developers to concentrate on the contents rather than the formatting.

Best would be to use a carpentries-wide adopted/recommended tool and the same configuration file.
@jhlegarreta
Copy link
Contributor Author

Cross-referencing #85 (comment) and #143.

Not sure if markdownlint is able to actually apply the format to the files or else it just flags the non-conforming lines; prettier seems to do both jobs.

@jhlegarreta jhlegarreta added good first issue Good issue for first-time contributors type:formatting Formatting needs to be fixed labels Apr 23, 2021
@jhlegarreta jhlegarreta mentioned this issue Aug 13, 2021
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue Good issue for first-time contributors type:formatting Formatting needs to be fixed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@jhlegarreta