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

Adds yamllint and markdownlint #50

Merged
merged 4 commits into from
Feb 3, 2025
Merged

Conversation

san983
Copy link
Member

@san983 san983 commented Jan 30, 2025

This PR adds YAML and Markdown linters config and make them run in the CI Github Action.

This is an effort on standardizing our Erlang repositories.

:shipit: Deploy Steps

  • Just merge, no need to cut a release for this

:shipit: Verification Steps

  • CI passing while executing YAML and Markdown linters

- CONTRIBUTING.md:5 MD001/heading-increment Heading levels should only increment by one level at a time [Expected: h3; Actual: h4]

- README.md:66:234 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]
./.github/dependabot.yml
  1:1       warning  missing document start "---"  (document-start)

./.github/workflows/check_deps.yml
  1:1       warning  missing document start "---"  (document-start)

./.github/workflows/ci.yml
  1:1       warning  missing document start "---"  (document-start)
  6:16      error    too many spaces inside brackets  (brackets)
  6:23      error    too many spaces inside brackets  (brackets)
@san983 san983 self-assigned this Jan 30, 2025
@san983 san983 added the enhancement New feature, enhancement or code changes, not related to defects label Jan 30, 2025
@san983 san983 changed the title Task/adds yamllint and markdownlint Adds yamllint and markdownlint Jan 31, 2025
@san983 san983 requested review from weppos and a team January 31, 2025 12:19
@san983 san983 marked this pull request as ready for review January 31, 2025 12:21
@san983 san983 mentioned this pull request Jan 31, 2025
6 tasks
@@ -1,3 +1,5 @@
---
Copy link
Member

Choose a reason for hiding this comment

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

Same comment as the other PRs. Please ensure the standard templates are updated.

@san983 san983 merged commit 4fd4661 into main Feb 3, 2025
8 checks passed
@san983 san983 deleted the task/adds-yamllint-and-markdownlint branch February 3, 2025 15:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature, enhancement or code changes, not related to defects
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants