Skip to content

docs: simplify lint and format guidance - #69

Merged
megabyde merged 1 commit into
mainfrom
docs/simplify-lint-guidance
Jul 27, 2026
Merged

docs: simplify lint and format guidance#69
megabyde merged 1 commit into
mainfrom
docs/simplify-lint-guidance

Conversation

@megabyde

Copy link
Copy Markdown
Owner

Summary

  • tighten the README description of format and lint ownership
  • remove the duplicated Ruff rule catalog from the README
  • remove comments that restate the adjacent Make and Ruff configuration

Why

The configuration remains the source of truth for exact rule selections and source paths. The retained README text still documents each tool, its scope, failure behavior, and the shared CI version pins without duplicating details that can drift.

Validation

  • ruff format --check scripts/ conanfile.py
  • ruff check scripts/ conanfile.py
  • Prettier 3.9.6 on README.md
  • markdownlint-cli2 0.23.1 on README.md
  • git diff --check

@megabyde
megabyde merged commit 7bde13f into main Jul 27, 2026
17 checks passed
@megabyde
megabyde deleted the docs/simplify-lint-guidance branch July 27, 2026 03:44
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