Skip to content

docs: add CHANGELOG.md + CITATION.cff (OSS launch checklist)#382

Merged
SoundMindsAI merged 2 commits into
mainfrom
chore/launch-changelog-citation
Jun 1, 2026
Merged

docs: add CHANGELOG.md + CITATION.cff (OSS launch checklist)#382
SoundMindsAI merged 2 commits into
mainfrom
chore/launch-changelog-citation

Conversation

@SoundMindsAI

Copy link
Copy Markdown
Owner

Works through three Section B items on docs/00_overview/oss-launch-checklist.md.

Added

  • CHANGELOG.mdKeep a Changelog 1.1.0 format. Documents v0.1.0v0.1.3 (reconstructed from the GitHub Releases + tag history) plus an [Unreleased] section that captures the MVP2 work already on main: 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 when v0.2.0 is tagged. Includes compare links between every version.
  • CITATION.cffCFF 1.2.0. Powers GitHub's "Cite this repository" button and cffconvert. Title/abstract/keywords aimed at the relevance/IR community; version pinned to the latest release (v0.1.3) — bump version + date-released at each tag.

Plumbing

  • REUSE.toml — added **/*.cff to the structured-data glob so the license-headers REUSE gate stays green (reuse lint: 1655/1655 compliant).

Checklist bookkeeping (ticked in this PR)

release.yml was 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

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>

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread CHANGELOG.md Outdated
`capture_logs()` and making the full randomized suite nondeterministically
red; fixed by mutating the list in place. (#364)

### Infrastructure

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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.

Suggested change
### 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>
@SoundMindsAI

Copy link
Copy Markdown
Owner Author

Gemini review adjudication

Finding Verdict Resolution
CHANGELOG.md:74### Infrastructure is not a standard Keep a Changelog category (only Added/Changed/Deprecated/Removed/Fixed/Security) Accept Folded the Solr-Compose + Alembic-head bullets into the existing [Unreleased] ### Changed section; dropped the non-standard heading (3c0fd73f).

CI

Docs-only PR. On the prior commit the full pr.yml suite was green except smoke, which fails on the known pre-existing relyloop-solr-1 exited (1) crash (tracked in infra_solr_smoke_stability). The REUSE license-headers gate passed with the new **/*.cff annotation (1655/1655). main no longer requires heavy-CI checks, so this merges on the fast lane.

@SoundMindsAI SoundMindsAI merged commit 8ab672a into main Jun 1, 2026
12 checks passed
@SoundMindsAI SoundMindsAI deleted the chore/launch-changelog-citation branch June 2, 2026 13:02
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