ADR-0004: Add markdown linter - Githubissues

microsoft / carbon-aware-sdk

Carbon-Aware Core SDK

MIT License

14 stars 8 forks source link

ADR-0004: Add markdown linter #221

Open bderusha opened 1 year ago

bderusha commented 1 year ago

User Story

As a carbon aware sdk contributor, I want to know when my markdown files do not meet the standard set by ADR-0004 so I can fix them.

Design Goals

Run markdown-lint on all PRs via GithubActions
Do not make running the linter contingent upon fixing all existing violations
Ability to customize linting rules and use those rules both in CI and local development

Stretch Goal

Ability to auto-fix violations in some manner

Acceptance Criteria

[x] markdown-linter runs against PRs
[x] markdown-linter merging will not block existing PRs

Implementation Notes

There is a test branch, 221/markdown-linter, which uses the same MegaLinter as the code-with-engineering-playbook
https://megalinter.io/latest/ offers the ability to add other linters easily and supports auto-fixing.

JenMadiedo commented 1 year ago

PR: https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/243