docs: add lint/format guidance to CONTRIBUTING.md to prevent ruff CI failures#80
Merged
Conversation
Copilot
AI
changed the title
[WIP] Fix failing GitHub Actions job lint
docs: add lint/format guidance to CONTRIBUTING.md to prevent ruff CI failures
Jul 4, 2026
Alphanymous
approved these changes
Jul 4, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
CI lint job failed because
elesync/web.pywas committed with uppercase Unicode escape sequences (\u270F,\u26A1,\u2B07,\u22EE) that ruff normalizes to lowercase. CONTRIBUTING.md had no mention of ruff or pre-commit setup, making this easy to hit silently.What this changes
pre-commit installto the setup snippet so the ruff-format hook activates automatically on every commitruff check/ruff format) and explicitly calls out that ruff normalizes Unicode escape sequences to lowercase — the exact pattern that caused this failureHow to verify
pip install -e ".[dev]" ruff check elesync/ tests/ scripts/ ruff format --check elesync/ tests/ scripts/ mypy elesync/All should pass with no issues.
Checklist
python -m unittest discover -s testsis green