Skip to content

Enforce shared Oxford spelling#31

Merged
leynos merged 2 commits into
mainfrom
typos-roll-out
Jul 10, 2026
Merged

Enforce shared Oxford spelling#31
leynos merged 2 commits into
mainfrom
typos-roll-out

Conversation

@leynos

@leynos leynos commented Jul 10, 2026

Copy link
Copy Markdown
Owner

Summary

This branch rolls the shared en-GB-oxendict spelling foundation into both the
Copier template repository and every rendered Python or Rust-enabled project.
It conditionally refreshes the estate dictionary into ignored cache files,
merges narrow local policy, commits deterministic typos.toml output, pins
typos at one Makefile source of truth, and enforces spelling locally and in
GitHub Actions.

The change also corrects all spelling findings in maintained template prose.
Two verbatim exports of upstream Copier documentation remain unchanged and are
excluded only in the parent overlay. The Microsoft Learn citation title is
likewise ignored by an exact pattern rather than rewritten.

No linked issue or roadmap task was found for this estate rollout.

Review walkthrough

  • Start with ADR-003
    for the shared-base decision and trade-offs.
  • Review the paired parent generator
    and core refresh helper, then confirm their copies under template/scripts/
    are byte-identical.
  • Check the parent and generated Makefile
    plus CI workflow
    for the pinned, serialized spelling gates.
  • Review the rollout tests
    and generated-project contracts for cache identity, offline reuse,
    deterministic TOML, drift, property invariants, the real pinned binary, and
    Copier output.
  • Finish with the local overlays and spelling-only prose corrections, paying
    particular attention to preserved upstream names and quotations.

Validation

  • make check-fmt: passed.
  • make lint: passed; Ruff and 100% Interrogate coverage are green.
  • make typecheck: passed.
  • make spelling: passed with typos 1.48.0.
  • make test: passed; 41 tests passed and two opt-in act tests skipped.
  • Python 3.13 compilation and focused rollout tests: passed; eight tests.
  • mbake validate Makefile: passed.
  • Changed-file markdownlint-cli2: passed for all ten changed prose files.
  • nixie --no-sandbox: passed.
  • git diff --check: passed.

The repository-wide Markdown lint command also reports 497 pre-existing
findings in the two verbatim Copier documentation exports; neither file is
changed by this branch, and the bounded changed-file Markdown gate is green.

Generate parent and rendered-project typos configuration from the shared
estate dictionary plus narrow local overlays. Add pinned local and CI gates,
contract and behavioural coverage, and correct the spelling findings exposed
in generated guidance.
@coderabbitai

coderabbitai Bot commented Jul 10, 2026

Copy link
Copy Markdown

Warning

Review limit reached

You’ve reached a temporary PR review limit under our Fair Usage Limits Policy.

Your recent review volume is higher than typical usage, so adaptive limits are currently applied.

Next review available in: 59 minutes

Your organization has reached its usage spending cap. Adjust your spending cap in the billing tab.

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 051c4f46-e798-4695-b735-a3abe8403b93

📥 Commits

Reviewing files that changed from the base of the PR and between 49d5b5c and 562d5ef.

📒 Files selected for processing (33)
  • .github/workflows/ci.yml
  • .gitignore
  • Makefile
  • docs/adr-001-template-quality-gates.md
  • docs/adr-003-shared-oxford-spelling-base.md
  • docs/developers-guide.md
  • pytest.ini
  • scripts/generate_typos_config.py
  • scripts/typos_rollout.py
  • template/.github/workflows/ci.yml.jinja
  • template/.gitignore
  • template/.rules/python-exception-design-raising-handling-and-logging.md
  • template/.rules/python-pyproject.md
  • template/.rules/python-typing.md
  • template/AGENTS.md.jinja
  • template/Makefile.jinja
  • template/docs/complexity-antipatterns-and-refactoring-strategies.md
  • template/docs/developers-guide.md
  • template/docs/users-guide.md.jinja
  • template/scripts/generate_typos_config.py
  • template/scripts/typos_rollout.py
  • template/typos.local.toml
  • template/typos.toml
  • tests/__snapshots__/test_template.ambr
  • tests/helpers/agents_contracts.py
  • tests/helpers/ci_contracts.py
  • tests/helpers/makefile_contracts.py
  • tests/test_helpers.py
  • tests/test_parent_ci.py
  • tests/test_template.py
  • tests/test_typos_rollout.py
  • typos.local.toml
  • typos.toml
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch typos-roll-out

Comment @coderabbitai help to get the list of available commands.

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Sorry @leynos, your pull request is larger than the review limit of 150000 diff characters

Keep parentheses around multi-exception clauses in the shared spelling
helper. Python 3.14 accepts the compact form produced locally, but generated
projects and hosted CI support Python 3.13.
@leynos leynos marked this pull request as ready for review July 10, 2026 08:54
@leynos

leynos commented Jul 10, 2026

Copy link
Copy Markdown
Owner Author

@coderabbitai review

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Sorry @leynos, your pull request is larger than the review limit of 150000 diff characters

@coderabbitai

coderabbitai Bot commented Jul 10, 2026

Copy link
Copy Markdown
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@leynos leynos merged commit c8be1ae into main Jul 10, 2026
6 checks passed
@leynos leynos deleted the typos-roll-out branch July 10, 2026 08:55

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 562d5efe6f

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

run: make typecheck

- name: Check spelling
run: make spelling

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Fail CI when generated typos config drifts

When this rendered workflow runs on generated projects, make spelling regenerates the tracked typos.toml before checking Markdown, but the job never verifies that the checkout stayed clean. If a PR updates typos.local.toml or runs after the shared base advances without committing the regenerated typos.toml, CI will silently modify the runner's copy and still pass, leaving the repository with stale spelling policy.

Useful? React with 👍 / 👎.

Comment thread scripts/typos_rollout.py
Comment on lines +357 to +358
saved = _read_metadata(metadata)
request = _https_request(source, _conditional_headers(saved))

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Ignore cached HTTP validators when the source changes

When callers switch from one HTTPS dictionary source to another, this reuses ETag/Last-Modified values read for the old URL because saved["source"] is never compared with source. If the new URL returns 304 or a 200 whose Last-Modified is not newer than the old metadata, _refresh_http returns current and keeps the old cache; the local-source path already avoids this by matching the source name, so the HTTP path should clear validators unless they belong to the requested URL.

Useful? React with 👍 / 👎.

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.

1 participant