Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

docs: changelog fragments instead of one shared CHANGELOG.md (every PR conflicts on it)

オープン
#1,268 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
45/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
c

調査の方向性

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 の本文から書いたものです。

説明

area:docs help wanted kind:decision

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 via blurb.
  • Go (since 1.23): doc/next/*.md fragments merged into the release notes.
  • Rust: a relnotes PR label, from which the release team curates RELEASES.md.
  • Many Python projects: towncrier.

Bar (what must be true).

  1. A PR adds changes/<category>/<PR-or-slug>.md (category ∈ Added/Changed/Fixed/Removed/Security or the repo's existing headings) and never edits CHANGELOG.md directly.
  2. The release-cut step (tools/ + the release skill) assembles the fragments into a new CHANGELOG.md section and deletes them, deterministically: same fragments → byte-identical section.
  3. A gate: a PR that touches src/ or lib/ without a fragment fails, unless an explicit skip-changelog label or trailer is present. CHANGELOG.md edits outside a release cut fail.
  4. Two PRs each adding a fragment never conflict with each other. Prove it with two branches.
  5. Existing history in CHANGELOG.md is 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

環境構築

Codespaces で開く

このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

InauguralSystems/EigenScript のほかの issue

InauguralSystems/EigenScript の issue をすべて見る

似ている issue

C の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。