docs: add CHANGELOG.md + CITATION.cff (OSS launch checklist)#382
Conversation
Two missing Section B launch-plumbing files: - CHANGELOG.md — Keep a Changelog 1.1.0, covering v0.1.0–v0.1.3 plus an [Unreleased] section for the MVP2 work on main (Solr adapter, UBI judgments, convergence indicator, overnight autopilot). Closes when v0.2.0 is tagged. - CITATION.cff — CFF 1.2.0; powers GitHub's 'Cite this repository'. Version pinned to the latest release (v0.1.3). REUSE: added **/*.cff to the structured-data glob in REUSE.toml so the license-header gate stays green (reuse lint: 1655/1655). Checklist bookkeeping: ticked Section A 'Ship it' (Solr-shipped reconcile verified clean — done via #354 + follow-ons) and the two Section B items. release.yml deferred by request. Signed-off-by: SoundMindsAI <eric.starr@soundminds.ai>
There was a problem hiding this comment.
Code Review
This pull request adds project metadata and documentation files, including a comprehensive CHANGELOG.md following the Keep a Changelog standard, a CITATION.cff file for academic citations, and updates to REUSE.toml and the OSS launch checklist. The feedback suggests renaming the non-standard ### Infrastructure section in the changelog to a standard category like ### Changed to maintain compliance with automated changelog parsers.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
| `capture_logs()` and making the full randomized suite nondeterministically | ||
| red; fixed by mutating the list in place. (#364) | ||
|
|
||
| ### Infrastructure |
There was a problem hiding this comment.
According to the Keep a Changelog specification, the standard change categories are Added, Changed, Deprecated, Removed, Fixed, and Security. Using a non-standard category like Infrastructure may not be recognized by automated changelog parsers. Consider renaming this section to Changed or Added to maintain standard compliance.
| ### Infrastructure | |
| ### Changed |
Adjudicate Gemini finding (Accept): Keep a Changelog defines only Added/Changed/Deprecated/Removed/Fixed/Security. Move the Solr-Compose + Alembic-head bullets under the existing [Unreleased] Changed section. Signed-off-by: SoundMindsAI <eric.starr@soundminds.ai>
Gemini review adjudication
CIDocs-only PR. On the prior commit the full |
Works through three Section B items on
docs/00_overview/oss-launch-checklist.md.Added
CHANGELOG.md— Keep a Changelog 1.1.0 format. Documentsv0.1.0–v0.1.3(reconstructed from the GitHub Releases + tag history) plus an[Unreleased]section that captures the MVP2 work already onmain: the Apache Solr adapter (three-engine reach), UBI judgments, study convergence indicator, overnight autopilot, engine-tolerant demo reseed, and the Fusion removal. The[Unreleased]section closes whenv0.2.0is tagged. Includescomparelinks between every version.CITATION.cff— CFF 1.2.0. Powers GitHub's "Cite this repository" button andcffconvert. Title/abstract/keywords aimed at the relevance/IR community;versionpinned to the latest release (v0.1.3) — bumpversion+date-releasedat each tag.Plumbing
REUSE.toml— added**/*.cffto the structured-data glob so thelicense-headersREUSE gate stays green (reuse lint: 1655/1655 compliant).Checklist bookkeeping (ticked in this PR)
CHANGELOG.mdandCITATION.cff→ done.release.ymlwas intentionally deferred this round (operator chose to skip it for now). Remaining Section 0 items are operator-only (branch protection, trademark search) or need a running stack / screen recording (demo gif, guide screenshots).Docs-only — no code, no migration, no coverage impact.
🤖 Generated with Claude Code