Conversation
This PR updates the codegen files. Co-authored-by: ptr727-codegen[bot] <275599072+ptr727-codegen[bot]@users.noreply.github.com>
…oc conventions (#114) 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).
Contributor
There was a problem hiding this comment.
Pull request overview
This PR is a develop -> main release merge that aligns the repository with the newly documented text-hygiene conventions (ASCII-only agent-authored text and .editorconfig-driven line endings) and refreshes generated codegen output.
Changes:
- Normalize typographic Unicode to ASCII across docs, comments, workflow comments, and other non-functional text.
- Normalize line endings across the repo to match
.editorconfig(with resulting whole-file churn in many tracked files). - Refresh codegen output (
CodeGen/CodeGen.cs) with a new generated timestamp.
Reviewed changes
Copilot reviewed 30 out of 31 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| README.md | Adds/expands template setup guidance (rulesets export/import, signing order) and standardizes ASCII punctuation. |
| PyPiLibrary/src/ptr727_projecttemplate_library/example.py | Replaces typographic Unicode in module docstring. |
| PyPiLibrary/src/ptr727_projecttemplate_library/_version.py | Standardizes docstring punctuation and arrow notation to ASCII. |
| PyPiLibrary/README.md | Repo-wide ASCII normalization and line ending normalization in Python template docs. |
| PyPiLibrary/pyproject.toml | Standardizes description/comments to ASCII. |
| PyPiLibrary/CODESTYLE.md | Standardizes punctuation/wording to ASCII across Python style guide. |
| HISTORY.md | Line ending normalization only. |
| docs/ssh-signing.md | Standardizes punctuation/notation to ASCII while preserving content. |
| docs/host-setup.md | Standardizes punctuation/notation to ASCII while preserving content. |
| docs/devcontainer.md | Standardizes punctuation/notation to ASCII while preserving content. |
| CODESTYLE.md | Standardizes punctuation/notation to ASCII in .NET style guide. |
| CodeGen/CommandLine.cs | Comment-only ASCII normalization (no functional change). |
| CodeGen/CodeGenBuilder.cs | Comment-only ASCII normalization (no functional change). |
| CodeGen/CodeGen.cs | Updates generated timestamp output. |
| AGENTS.md | Adds explicit repo-wide conventions (ASCII, line endings, doc tense) and expands setup guidance. |
| .github/workflows/test-pull-request.yml | Comment-only ASCII normalization / line ending normalization. |
| .github/workflows/run-periodic-codegen-pull-request.yml | Comment-only ASCII normalization / line ending normalization. |
| .github/workflows/run-codegen-pull-request-task.yml | Comment-only ASCII normalization / line ending normalization. |
| .github/workflows/publish-release.yml | Comment-only ASCII normalization / line ending normalization. |
| .github/workflows/merge-bot-pull-request.yml | Comment-only ASCII normalization / line ending normalization. |
| .github/workflows/get-version-task.yml | Comment-only ASCII normalization / line ending normalization. |
| .github/workflows/build-release-task.yml | Comment-only ASCII normalization / line ending normalization. |
| .github/workflows/build-pypilibrary-task.yml | Comment-only ASCII normalization / line ending normalization. |
| .github/workflows/build-nugetlibrary-task.yml | Comment-only ASCII normalization / line ending normalization. |
| .github/workflows/build-executable-task.yml | Comment-only ASCII normalization / line ending normalization. |
| .github/workflows/build-docker-task.yml | Comment-only ASCII normalization / line ending normalization. |
| .github/dependabot.yml | Comment-only ASCII normalization / line ending normalization. |
| .github/copilot-instructions.md | Standardizes punctuation/notation to ASCII in Copilot runbook docs. |
| .devcontainer/python/post-create.sh | Comment/error-message ASCII normalization only. |
| .devcontainer/python/devcontainer.json | Line ending normalization only. |
| .devcontainer/dotnet/devcontainer.json | Line ending normalization only. |
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
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 freeto 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.
Release of develop -> main. Two changes:
.editorconfigline endings repo-wide; tighten doc conventions (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.editorconfigline 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.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...developisolates the real content edits.