CODESTYLE: defer line endings to AGENTS.md (don't hardcode CRLF) - #291
Merged
Conversation
The line-ending item stated a fixed "CRLF for YAML/JSON/..." rule, which contradicts operational (Linux-consumed config) repos that use a global LF default per their .editorconfig and the AGENTS.md operational lineEndings rule. Line-ending governance already lives in AGENTS.md; point to it instead of restating a fixed ending here. Surfaced by Copilot on a HomeAssistant config repo (lf) carrying this doc verbatim. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the general style guidance to avoid hardcoding a CRLF default in CODESTYLE.md, deferring line-ending governance to the canonical rules in AGENTS.md so operational repos can correctly use an LF default where appropriate.
Changes:
- Replace the fixed “CRLF for YAML/JSON/…” line-ending rule in
CODESTYLE.mdwith a reference toAGENTS.mdas the source of truth. - Summarize the repo-governed default behavior (via
.editorconfig/.gitattributes) in the same bullet.
…t LF-only Copilot: the reworded summary implied operational repos default to LF, but per AGENTS.md an operational repo's global default follows its consuming application's native platform - LF (ESPHome/Home Assistant on Linux) or CRLF (Vantage / Design Center on Windows). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…statement) Copilot: since the intent is to defer, don't restate a partial summary of the policy - just point to the AGENTS.md "Line Endings" section. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
ptr727
added a commit
that referenced
this pull request
Jul 13, 2026
…epos (#292) Promote the current `develop` snapshot to `main`. Adds the **operational** workflow model and its supporting rules/tooling (PRs #287-#291): - **#287** operational `workflowModel` (direct-to-`develop` live-config repos; shared `main` ruleset; dispatch-only releases; model-aware `configure.sh`). - **#288** per-repo `lineEndings` field (operational repos follow the consuming app's platform; validated). - **#289** mixed-consumer EOL guidance (prefer splitting by platform); dropped the standalone Vantage-Config catalog entry (later re-added, recreated single-platform). - **#290** renamed `HomeAutomation` -> `HomeAutomation-Config`; EOL guidance leads with the split-preferred approach. - **#291** CODESTYLE.md defers line-ending governance to AGENTS.md (was hardcoding CRLF, contradicting `lf` operational repos). Applied end-to-end to ESPHome-Config, HomeAutomation-Config, HomeAssistant-Config (lf) and the recreated Vantage-Config (crlf). 🤖 Generated with [Claude Code](https://claude.com/claude-code)
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.
Summary
CODESTYLE.md's line-ending item stated a fixed "CRLF for YAML/JSON/..." rule, which contradicts operational (Linux-consumed config) repos that use a global LF default per their
.editorconfigand the AGENTS.md operationallineEndingsrule. Line-ending governance already lives in AGENTS.md ("Line Endings"), so point to it instead of restating a fixed ending here.Context
Surfaced by Copilot while reviewing HomeAssistant-Config (an
lfoperational repo) carrying CODESTYLE.md verbatim - the hardcoded CRLF line read as misleading guidance for that repo.Verification
markdownlint + cspell clean.
🤖 Generated with Claude Code