Context
If every pull request edits the top of CHANGELOG.md, every concurrent pull
request conflicts on the same handful of lines. The fix is well-established:
each PR writes its own small file, and a release command merges them. See
docs/dx_1/002_changelog.md §3.
Scope
- Create
.changelog/unreleased/ with a README.md explaining the workflow and
a TEMPLATE.md showing the frontmatter.
- Define the entry schema:
type (the six categories), area (enum: trade,
pools, earn, referrals, faucet, wallet, docs, ci, internal), pr (number),
breaking (boolean), plus a markdown body of one or two sentences.
- Naming convention
<pr-number>-<kebab-slug>.md, so two PRs can never collide.
- Document in
CONTRIBUTING.md and AGENTS.md when an entry is required — any
user-visible change — and when it is not.
- Add a worked example entry file that the validator (DX-003) will accept.
Acceptance criteria
Out of scope
- The validation script (DX-003) and the release command (DX-004).
Spec: docs/dx_1/002_changelog.md · Depends on: DX-001
Context
If every pull request edits the top of
CHANGELOG.md, every concurrent pullrequest conflicts on the same handful of lines. The fix is well-established:
each PR writes its own small file, and a release command merges them. See
docs/dx_1/002_changelog.md§3.Scope
.changelog/unreleased/with aREADME.mdexplaining the workflow anda
TEMPLATE.mdshowing the frontmatter.type(the six categories),area(enum: trade,pools, earn, referrals, faucet, wallet, docs, ci, internal),
pr(number),breaking(boolean), plus a markdown body of one or two sentences.<pr-number>-<kebab-slug>.md, so two PRs can never collide.CONTRIBUTING.mdandAGENTS.mdwhen an entry is required — anyuser-visible change — and when it is not.
Acceptance criteria
.changelog/unreleased/exists with README and template, both accurate.CONTRIBUTING.mdandAGENTS.mdstate the requirement in their own voice.the demonstration in the PR description.
Out of scope
Spec:
docs/dx_1/002_changelog.md· Depends on: DX-001