adafruit / adafruit/awesome-circuitpython

Automatically run awesome-lint in CI?

Open
#35 1 comment 1 reaction 0 assignees View on GitHub
Dominant language
No language data
Stars
742
Forks
72
PR merge metrics
No merged PRs in 30d

Description

Some recent PRs mentioned tidying the markdown code with https://github.com/sindresorhus/awesome-lint -- is it something that we could/should do automatically during CI, similar to how we do pylint & black?

Contributor guide

Open the contributing guide

Research direction

Review the existing CI checks for pylint and black, then inspect the linked awesome-lint project and its requirements. Determine whether it can run against this repository's Markdown; done means the CI configuration runs the lint check automatically and reports failures on pull requests.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
ci-cd, documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.