Skip to content

Standardize ASCII and .editorconfig line endings repo-wide; tighten doc conventions - #114

Merged
ptr727 merged 5 commits into
developfrom
feature/doc-conventions-and-eol
Jun 5, 2026
Merged

Standardize ASCII and .editorconfig line endings repo-wide; tighten doc conventions#114
ptr727 merged 5 commits into
developfrom
feature/doc-conventions-and-eol

Conversation

@ptr727

@ptr727ptr727 commented Jun 5, 2026•
edited
Loading

Copy link
Copy Markdown
Owner

Repository-wide text hygiene plus authoring-rule documentation. No logic changes - source edits are in comments/docstrings/cosmetic strings and line endings only.

What

  • ASCII everywhere. Replace em-dashes and other typographic Unicode (arrows, <=, ellipsis, curly quotes) with ASCII across all tracked text files - docs, workflows, devcontainer.json, CodeGen/*.cs, and the PyPI package (comments/docstrings/cosmetic strings only). New AGENTS "Character Set" rule; scientific symbols and developer-typed emoji are the only exceptions.
  • .editorconfig line endings. Bring every file into compliance (CRLF for .md/.cs/XML/YAML/JSON/Windows-scripts, LF for .sh); several files had drifted to LF. New AGENTS "Line Endings" rule.
  • Setup docs. README + AGENTS: the ruleset export/import procedure (delete classic protection, export/import develop/main rulesets via gh api) and a signing-order warning.
  • Current-state tense. README rewritten to describe what is, not changes from a prior state; new AGENTS rule.

Scope note

This started as a docs-only pass. Copilot's review correctly flagged that the new ASCII rule was only half-applied - an earlier sweep had a bug that skipped .github/ and non-.md files. I extended it to the whole repo so the rule and the tree are consistent. All source changes are non-functional (EOL-preserving; the PyPI smoke build re-validates the PyPiLibrary edits).

Reviewing the diff

Line-ending normalization shows as whole-file churn under * -text; git diff --ignore-cr-at-eol isolates the real content edits (small - mostly — -> - in comments).

@ptr727
Tighten doc conventions and normalize line endings
e51342a
- Setup: add the ruleset export/import procedure (delete classic
protection, export/import the develop/main rulesets via gh api) and a
signing-order warning to README; add matching agent instructions to
AGENTS.md.
- ASCII: replace em-dashes and other typographic Unicode (arrows, <=,
ellipsis) across all docs with ASCII equivalents; add a Character Set
rule to AGENTS.md (scientific symbols and developer-typed emoji are the
only exceptions).
- Line endings: bring all files into .editorconfig compliance (CRLF for
the affected docs, workflows, dependabot.yml, devcontainer.json); add a
Line Endings rule to AGENTS.md.
- Tense: rewrite README in current-state form (drop now/no longer/restore
framing); add a current-state rule to AGENTS.md.
CopilotAI review requested due to automatic review settings June 5, 2026 16:05
CopilotAI reviewed Jun 5, 2026
View reviewed changes

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates repository documentation and authoring conventions, with a focus on tightening prose/style rules (ASCII-by-default, current-state phrasing, setup/ruleset procedures) and normalizing line endings to match .editorconfig.

Changes:

  • Expanded setup guidance in README.md/AGENTS.md (ruleset export/import procedure and a stronger “sign from the first commit” warning).
  • Standardized documentation prose (ASCII substitutions, current-state phrasing) across multiple docs/style guides.
  • Normalized line endings across docs/config files (including workflows and devcontainer JSON) to reduce editorconfig drift.

Reviewed changes

Copilot reviewed 8 out of 15 changed files in this pull request and generated 8 comments.

Show a summary per file
FileDescription
README.mdAdds/updates setup + ruleset procedure documentation and rewrites prose for consistency.
PyPiLibrary/README.mdASCII/prose normalization and formatting consistency for the Python-side README.
PyPiLibrary/CODESTYLE.mdASCII/prose normalization for Python style guide.
HISTORY.mdLine-ending/format normalization (no substantive content change).
docs/ssh-signing.mdASCII/prose normalization for signing documentation.
docs/host-setup.mdASCII/prose normalization for host setup documentation.
docs/devcontainer.mdASCII/prose normalization for devcontainer documentation.
CODESTYLE.mdASCII/prose normalization for .NET style guide.
AGENTS.mdAdds “current-state”, “character set”, and “line endings” conventions and updates prose.
.github/workflows/test-pull-request.ymlLine-ending normalization only (per PR intent).
.github/workflows/publish-release.ymlLine-ending normalization only (per PR intent).
.github/dependabot.ymlLine-ending normalization only (per PR intent).
.github/copilot-instructions.mdLine-ending normalization only (but still contains non-ASCII symbols that now conflict with AGENTS.md rules).
.devcontainer/python/devcontainer.jsonLine-ending normalization only (but contains typographic Unicode in comments).
.devcontainer/dotnet/devcontainer.jsonLine-ending normalization only (but contains typographic Unicode in comments).

Comment threadREADME.md Outdated
Comment threadAGENTS.md Outdated
Comment thread.github/copilot-instructions.md Outdated
Comment thread.github/copilot-instructions.md Outdated
Comment thread.github/copilot-instructions.md Outdated
Comment thread.github/copilot-instructions.md Outdated
Comment thread.devcontainer/dotnet/devcontainer.json
Comment thread.devcontainer/python/devcontainer.json
@ptr727
Extend ASCII convention repo-wide; refine signing and EOL rules
4444886
Round-2 review fixes for PR #114:
- Apply the ASCII convention to all tracked files, not just docs. An
earlier sweep skipped .github/ (a buggy path filter) and non-.md files,
leaving em-dashes/arrows in workflows, devcontainer.json, CodeGen *.cs,
and the PyPI package. All converted - comments/docstrings/cosmetic
strings only, EOL-preserving.
- README + AGENTS: correct the signing warning. A re-sign rewrite changes
every SHA and makes the rewriter the committer/signer; a rebase
preserves the author field, so drop the 'authorship is lost' claim.
- AGENTS: clarify the line-ending rule - new files follow .editorconfig,
edits preserve existing endings, and normalizing a non-compliant file
is a deliberate EOL-only change.
@ptr727
ptr727 requested a review from CopilotJune 5, 2026 16:17
@ptr727ptr727 changed the title Tighten doc conventions and normalize line endingsStandardize ASCII and .editorconfig line endings repo-wide; tighten doc conventionsJun 5, 2026
CopilotAI reviewed Jun 5, 2026
View reviewed changes

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 29 out of 30 changed files in this pull request and generated 2 comments.

Comment thread.github/workflows/build-pypilibrary-task.yml Outdated
Comment threadAGENTS.md Outdated
@ptr727
Fix mangled uv-pin comment and soften the EOL-normalization rule
fd7e8b2
Round-3 review fixes for PR #114:
- build-pypilibrary-task.yml: the ASCII sweep turned an em-dash at the
start of a wrapped comment line into '# - ', which read as a bullet and
broke the sentence. Rephrased so it reads as prose.
- AGENTS Line Endings: relax 'never mixed into a content edit' - prefer an
isolated EOL-only commit, but allow a repo-wide cleanup to normalize
alongside content when called out and verified with --ignore-cr-at-eol.
@ptr727
ptr727 requested a review from CopilotJune 5, 2026 16:24
CopilotAI reviewed Jun 5, 2026
View reviewed changes

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 29 out of 30 changed files in this pull request and generated 1 comment.

Comment threadREADME.md Outdated
@ptr727
Align secrets-store path wording to 'GitHub project Settings'
7e50c1d
Round-4 review fix for PR #114: two App-token bullets said 'GitHub project
security Settings'; the rest of the section (and GitHub's actual UI path)
uses 'GitHub project Settings'. Made them consistent.
@ptr727
ptr727 requested a review from CopilotJune 5, 2026 16:30
CopilotAI reviewed Jun 5, 2026
View reviewed changes

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 29 out of 30 changed files in this pull request and generated 1 comment.

Comment threadAGENTS.md
@ptr727
Restore the Quantitative Claims heading in AGENTS.md
439b175
Round-5 review fix for PR #114: an earlier edit that added the Line
Endings subsection dropped the '### Quantitative Claims' heading, leaving
its guidance as a stray bullet. Heading restored.
@ptr727
ptr727 requested a review from CopilotJune 5, 2026 16:35
CopilotAI reviewed Jun 5, 2026
View reviewed changes

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 29 out of 30 changed files in this pull request and generated no new comments.

@ptr727
ptr727 merged commit 7099065 into developJun 5, 2026
14 checks passed
@ptr727
ptr727 deleted the feature/doc-conventions-and-eol branch June 5, 2026 16:39
@ptr727ptr727 mentioned this pull request Jun 5, 2026
Merged
ptr727 added a commit that referenced this pull request Jun 5, 2026
@ptr727
Standardize ASCII and line endings repo-wide; refresh codegen (#115)
e9d8d8a
Release of develop -> main. Two changes:
- **Standardize ASCII and `.editorconfig` line endings repo-wide;
tighten doc conventions (#114)** - replace typographic Unicode
(em-dashes, arrows, `<=`, ellipsis) with ASCII across all tracked files;
bring every file to its `.editorconfig` line ending; add the ruleset
export/import + signing-order setup docs; add AGENTS rules (Character
Set, Line Endings, current-state tense, ruleset-setup). Source edits are
comments/docstrings/cosmetic-strings and line endings only - no logic
change.
- **Update codegen files (#113).**
Merge-commit (not squash) per the branching model.
The insertions/deletions count is dominated by line-ending normalization
(whole-file churn under `* -text`); `git diff --ignore-cr-at-eol
main...develop` isolates the real content edits.
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code reviewCopilot
Copilot review effort
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@ptr727