docs: changelog fragments instead of one shared CHANGELOG.md (every PR conflicts on it)
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 45/100
- issue の種類
- ドキュメント
- 明瞭さ
- 明確に書かれている
- 活発さ
- 活発
- 技術スタック
- c
- 領域
- documentation, release
調査の方向性
Look at the existing CHANGELOG.md structure and the release process in tools/. Study how other projects like CPython (blurb) or Go implement fragment-based changelogs. The work involves creating a new directory (e.g., changes/), writing a script to assemble fragments, and adding a CI gate to enforce fragment creation for PRs touching src/ or lib/. Done when two PRs adding fragments no longer conflict and the release script produces an identical CHANGELOG.md section.
索引モデルが issue の本文から書いたものです。
説明
Problem. CHANGELOG.md is one 11,638-line file touched by 66 commits in the last month. Every concurrent PR edits the same region, so every pair of PRs conflicts on it: the same friction class as the pinned counts in #1264 (a conflict also stops pull_request CI from running at all, as seen on #1260).
What mature languages do. Each change carries its own fragment file, and a tool assembles them at release:
- CPython:
Misc/NEWS.d/fragments viablurb. - Go (since 1.23):
doc/next/*.mdfragments merged into the release notes. - Rust: a
relnotesPR label, from which the release team curatesRELEASES.md. - Many Python projects:
towncrier.
Bar (what must be true).
- A PR adds
changes/<category>/<PR-or-slug>.md(category ∈ Added/Changed/Fixed/Removed/Security or the repo's existing headings) and never editsCHANGELOG.mddirectly. - The release-cut step (
tools/+ the release skill) assembles the fragments into a newCHANGELOG.mdsection and deletes them, deterministically: same fragments → byte-identical section. - A gate: a PR that touches
src/orlib/without a fragment fails, unless an explicitskip-changeloglabel or trailer is present.CHANGELOG.mdedits outside a release cut fail. - Two PRs each adding a fragment never conflict with each other. Prove it with two branches.
- Existing history in
CHANGELOG.mdis untouched.
Ranked #1 of the docs follow-ups from the 2026-09-22 comparison with other languages (cheapest, and it removes a guaranteed conflict from every PR). Refs #1264.
- 主要言語
- C
- スター
- 3
- フォーク
- 7
- 平均マージ
- 3時間 58分
- マージ済み PR(30日)
- 105
環境構築
このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。
- Dockerfile または Docker Compose ファイルあり
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
InauguralSystems/EigenScript のほかの issue
-
area:lint-tooling bug
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
InauguralSystems/EigenScript#1340 ·
メンテナーはふだん 1 日以内に返信
-
area:stdlib found-by:code-review kind:silent-wrong
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
InauguralSystems/EigenScript#1338 ·
メンテナーはふだん 1 日以内に返信
-
area:lint-tooling found-by:critic kind:docs-drift
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
InauguralSystems/EigenScript#1335 ·
メンテナーはふだん 1 日以内に返信
-
area:ci found-by:critic kind:gate-defect
難易度 2/5 1〜3時間 初心者へのやさしさ 86/100
InauguralSystems/EigenScript#1311 ·
メンテナーはふだん 1 日以内に返信
-
enrolment: decide test_gc_runner_controls.py (exempt vs enrol) and whether floors need a ratchetオープンarea:gates found-by:critic kind:decision
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
InauguralSystems/EigenScript#1280 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
InauguralSystems/EigenScript の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
-
難易度 1/5 1時間未満 初心者へのやさしさ 75/100
NabuCasa/silabs-firmware-builder#231 · コメント 1 件 ·
-
難易度 1/5 1〜3時間 初心者へのやさしさ 88/100
ClickHouse/pg_clickhouse#383 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
johnsonjh/emu2-cpm86#68 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 1 日以内に返信