Skip to content

docs: add lint/format guidance to CONTRIBUTING.md to prevent ruff CI failures#80

Merged
Alphanymous merged 2 commits into
masterfrom
copilot/fix-lint-job
Jul 4, 2026
Merged

docs: add lint/format guidance to CONTRIBUTING.md to prevent ruff CI failures#80
Alphanymous merged 2 commits into
masterfrom
copilot/fix-lint-job

Conversation

Copilot AI commented Jul 4, 2026

Copy link
Copy Markdown
Contributor

CI lint job failed because elesync/web.py was 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

  • Dev setup: adds pre-commit install to the setup snippet so the ruff-format hook activates automatically on every commit
  • New "Linting and formatting" section: documents the two ruff commands to run before pushing (ruff check / ruff format) and explicitly calls out that ruff normalizes Unicode escape sequences to lowercase — the exact pattern that caused this failure
  • Code style: adds a cross-reference to the new linting section

How 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

  • Tests added/updated and python -m unittest discover -s tests is green
  • Docs/README updated if behaviour changed
  • No new core runtime dependencies (or justified in the PR)

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
Copilot AI requested a review from Alphanymous July 4, 2026 20:41
@Alphanymous Alphanymous marked this pull request as ready for review July 4, 2026 21:36
@Alphanymous Alphanymous merged commit 18eadbe into master Jul 4, 2026
4 checks passed
@Alphanymous Alphanymous deleted the copilot/fix-lint-job branch July 4, 2026 21:36
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.

2 participants