Skip to content

Added markdown linting to pre-commit hooks #4975

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

Closed
wants to merge 19 commits into from

Conversation

Shrishti1701
Copy link
Contributor

This PR adds Markdown linting to the pre-commit hooks to ensure all .md files follow proper formatting standards. This helps maintain consistency and improves readability across the repository.

  • Changes Made

Updated .pre-commit-config.yaml to include markdownlint.
Removed unnecessary lines and reformatted the configuration file.
Installed and tested the pre-commit hook to ensure it runs correctly.

  • How to Test
  1. Install pre-commit hooks (if not already installed):

pre-commit install

  1. Run markdown linting on all files:

pre-commit run markdownlint --all-files

  1. Check if all markdown files comply with linting rules.
  • Expected Outcome

Markdown files should follow the correct formatting.
pre-commit run --all-files should pass without errors.

@Shrishti1701 Shrishti1701 marked this pull request as ready for review March 25, 2025 10:21
Copy link
Contributor

@terriko terriko left a comment

Choose a reason for hiding this comment

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

This PR seems to remove all the other linters, which isn't going to work for us.

@Shrishti1701 Shrishti1701 force-pushed the add-markdown-linter branch from 514aa5b to 202b400 Compare April 1, 2025 08:46
@Shrishti1701
Copy link
Contributor Author

I have changed the commit as you said. Let me know if it looks good now.

Copy link
Contributor

@terriko terriko left a comment

Choose a reason for hiding this comment

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

Getting close! One more minor fix needed, noted below.

@Shrishti1701
Copy link
Contributor Author

Shrishti1701 commented Apr 1, 2025

As you said i added back the comment part in the file.

@Shrishti1701 Shrishti1701 force-pushed the add-markdown-linter branch 2 times, most recently from 6c287e3 to 07d6fbc Compare April 3, 2025 19:06
@Shrishti1701 Shrishti1701 requested a review from terriko April 10, 2025 11:03
@Shrishti1701
Copy link
Contributor Author

I’ve resolved the issue related to the failing test. The "Tests that may fail due to network or HTML" error has been addressed. Kindly check the updated status and let me know if anything else needs attention.

@Shrishti1701
Copy link
Contributor Author

@terriko I am just not able to understand whats the issue with the workflows each time they are showing diif errors.Could you guide me in how to resolve this.

@Shrishti1701
Copy link
Contributor Author

The Markdown linter has been acting inconsistently, and after discussing it, we agreed it’s better to hold off on merging until it’s more stable. For now, I’m closing this out so I can focus on other contributions without being blocked.
If anyone wants to revisit this once the linter's in better shape, feel free to pick it up!

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

Successfully merging this pull request may close these issues.

2 participants