Skip to content

Conversation

@mattheliu
Copy link

🧩 What does this PR do?

This PR introduces an automated Markdown quality gate for the ERNIE repository by adding a GitHub Actions workflow that runs pymarkdown on every push and pull request affecting Markdown files.

It ensures that all documentation changes comply with the project's formatting standards before being merged.


🚀 Why is this needed?

Documentation quality is critical for usability and long-term maintenance.
Before this PR, Markdown style checks were performed manually, which was error-prone and inconsistent.

This workflow provides:

  • Automatic enforcement of Markdown conventions
  • Early detection of formatting issues in PRs
  • Reduced review overhead for maintainers
  • Improved consistency across documentation

🛠 What was added?

  • New GitHub Actions workflow:
    .github/workflows/markdown-lint.yml
  • Integrated pymarkdown as the Markdown linting engine
  • Triggered on push and pull_request for all .md files

🧪 How is it tested?

The same command is used both locally and in CI:

pymarkdown scan source/

@paddle-bot
Copy link

paddle-bot bot commented Dec 26, 2025

Thanks for your contribution!

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.

1 participant