Skip to content

v3開発ロードマップとブランチ運用を整備し、devの文書CIを省略 - #113

Merged
PyYoshi merged 6 commits into
devfrom
docs/v3-roadmap
Sep 20, 2026
Merged

PyYoshi merged 6 commits into
devfrom
docs/v3-roadmap

Conversation

@PyYoshi

@PyYoshi PyYoshi commented Sep 20, 2026 •

Copy link
Copy Markdown
Owner

概要

cChardet v3を、実データの取り込みに適したnative detectorとして改善するための開発ロードマップを追加します。必要な設計変更を互換性が妨げる場合は、移行方法を用意したうえで破壊的変更を選べる方針です。

本文は日本語で管理し、現状の2.3.0に既にある基盤と今後の実装を区別しています。9段階の依存関係・成果物・完了条件、最初の12作業、性能と精度の評価方法、corpus/modelの再現性・由来、失敗分析、API移行、条件付きのRust/SIMD研究を具体化しました。3.0のリリース条件と、v3系列全体の長期計画は分けています。

masterを安定版、devをv3開発の統合先とし、このPRもdev向けです。開発文書は日本語、利用者向け文書は英語を基本とする方針を明記し、READMEからロードマップへリンクしました。

C++20を有力候補として配布環境で検証し、RAII・借用buffer・型・compile時検証でmemory safetyを改善する方針を含みます。規格更新、所有権の整理、検出algorithmの変更は別の作業として扱います。

旧model生成scriptは参考調査に留め、新規generatorを基本方針とします。過去の再現性・品質問題の報告を記録し、決定性、再実行時のべき等性、生成modelの品質を別々に検証します。旧scriptの修復は前提にしません。

新規fileのlicenseは未決定と明示し、LGPL/MIT/Apache-2.0等を候補に、Phase 1でcomponent別に判断します。新規generatorを含む対象の実装・外部contribution受入れ前に方針を確定し、既存code、corpus、生成modelの条件は別々に確認します。このPRで既存licenseの変更や旧scriptの削除は行いません。

uchardetもcchardetをv2保守、devをv3開発として分離します。分岐点はcChardet 2.3.0が固定する7993e0afe3b6c64f0ea3b43c7d4987118f6c5c12です。共通修正の相互反映、PRのbase、release時のcommit固定を文書化しました。v3側の.gitmodulesは追跡branchをdevへ変更しますが、PyYoshi forkのURLとgitlinkは変更しません。

dev向けPRとpushでは、変更がMarkdown/reStructuredTextだけの場合にCIを起動しないようにします。master向けの既存必須チェックは維持します。テスト本体は再利用workflow、wheel生成は共通のcomposite actionを利用し、release tagと手動実行の動作は維持します。コード・設定・submodule変更を含むPRは通常どおり検証します。

v3の作業はcChardet側のIssueへ集約し、実装先repositoryと依存関係を明記して追跡する運用を追加しました。検出器の実装やRules設定の変更は含みません。

確認

  • 現在のcChardetと固定したuchardetのソース、workflow、generator、benchmark、test data policyと現状説明を照合。
  • 既存のuv環境でMarkdownのローカル参照・目次anchor・見出しの重複・READMEの導線を検証。
  • uchardetのdevとcchardetの分岐時commit、submoduleのURLとgitlinkを確認。
  • actionlint v1.7.12によるworkflow構文検査。
  • 40件のdev event/path条件、master必須チェック名、release/manual trigger、共通化前後のwheel生成stepの一致をlocalで確認。
  • git diff --check。更新commitのGitHub Actionsでテスト・配布物を検証。

@PyYoshi
PyYoshi marked this pull request as ready for review September 20, 2026 09:29
@PyYoshi PyYoshi changed the title docs: cChardet v3の開発ロードマップを日本語で整備 v3開発ロードマップとブランチ運用を整備し、devの文書CIを省略 Sep 20, 2026
@PyYoshi
PyYoshi merged commit 5a2f6da into dev Sep 20, 2026
20 checks passed
@PyYoshi
PyYoshi deleted the docs/v3-roadmap branch September 20, 2026 10:10
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