Skip to content

Conversation

gaius-qi
Copy link
Member

Description

This pull request adds automated linting for Markdown files to the repository by introducing a new GitHub Actions workflow and a custom lint configuration. The workflow ensures Markdown files follow the project's style guidelines on every push and pull request to the main branch.

Lint workflow setup:

  • Added .github/workflows/lint.yml to run Markdown linting on pushes and pull requests to the main branch using the avtodev/markdown-lint Docker image.

Lint configuration:

  • Added .markdownlint.yml to customize lint rules, including disabling MD010, setting a high line length for MD013, and specifying fenced code block style for MD046.

Related Issue

@gaius-qi gaius-qi self-assigned this Sep 10, 2025
Signed-off-by: Gaius <gaius.qi@gmail.com>
Copy link
Member

@chlins chlins left a comment

Choose a reason for hiding this comment

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

lgtm

@chlins chlins enabled auto-merge (squash) September 10, 2025 04:17
@chlins chlins merged commit 2dbd595 into master Sep 10, 2025
2 checks passed
@chlins chlins deleted the feature/lint branch September 10, 2025 04:21
@mingcheng mingcheng added the github actions Pull requests that update GitHub Actions code label Sep 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
github actions Pull requests that update GitHub Actions code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants