Skip to content

Add a CHANGELOG - #184

Merged
antonio-leblanc merged 1 commit into
forefireAPI:masterfrom
HugoFara:doc-changelog-master
Aug 13, 2026
Merged

Add a CHANGELOG#184
antonio-leblanc merged 1 commit into
forefireAPI:masterfrom
HugoFara:doc-changelog-master

Conversation

@HugoFara

Copy link
Copy Markdown
Collaborator

The repository has seven tags and six GitHub releases, and no file that tells a user what changed between them. pip install forefire sharpened that: someone pinning a version has the release notes on GitHub and nothing in the tree.

What is in it

Every release back to v1.1.0, reconstructed from the release notes and the commit history. It summarises each release rather than listing every commit — the Full Changelog link on each version gives the complete range.

Where a claim could be checked against the tags, it was:

ClaimCheck
listenHTTP is new in v2.0absent at v1.2, present at v2.0
RothermelAndrews2018 is new in v2.0file absent at v1.2, present at v2.0
The geojson dump mode is new in v1.2absent at v1.1.10

v2.1.122 is in the file with a note that it was tagged but never published as a release, so the gap between v2.0 and v2.4.2 is not silently missing.

[Unreleased] lists what is on this branch, not on dev

master is v2.5.0 plus #154 and #155, so those two are all that appears. dev carries a longer list in its own copy — see the backport, which is this branch's file with entries added and nothing removed, so merging dev into master resolves it without a conflict.

Also in here

  • CONTRIBUTING.md linked to a testing page that has never existed, at readthedocs.io/en/latest/developer_guide/testing.html, marked (Placeholder: Link to testing section once created). It points at TESTING.md, which until now nothing in the repository linked to at all.
  • A step asking for a changelog entry, so the file stays current instead of being reconstructed again in a year. It says to skip changes with no user-visible effect, so it does not become a tax on typo fixes.
  • README.md Key Links gains the changelog and TESTING.md.

Not done here

CONTRIBUTING.md still says to verify with cd tests && bash run.bash next to "Ensure all tests pass locally". On this branch that instruction fails: tests/run.bash runs runANN, which has been broken since it was committed. The fix is #183, which is on dev, and the corrected wording travels with it — documenting a working command here would have been documenting something master cannot do yet.

The wider documentation audit that produced this — the Read the Docs site never mentioning pip, tests/README.md naming files that do not exist, the emit command missing from the console's own help — is not in this change.


This pull request, including its code changes and this description, was generated by Claude Opus 5, and reviewed manually before submitting.

The repository has seven tags and six GitHub releases, and no file that
tells a user what changed between them. `pip install forefire` makes that
worse: someone pinning a version has the release notes on GitHub and
nothing in the tree.
CHANGELOG.md reconstructs every release from the release notes and the
commit history. Claims that could be checked were checked against the
tags: listenHTTP and RothermelAndrews2018 are absent at v1.2 and present
at v2.0, the geojson dump mode is absent at v1.1.10.
[Unreleased] lists only what is on this branch, forefireAPI#154 and forefireAPI#155. The dev
branch carries a longer list in its own copy, which supersedes this one
when dev is merged.
CONTRIBUTING.md now asks for an entry, so the file stays current instead
of being reconstructed again in a year. Its link to a testing page
pointed at a Read the Docs URL that has never existed; it points at
TESTING.md, which nothing in the repository linked to.

@antonio-leblancantonio-leblanc left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

ok only docs

@antonio-leblanc
antonio-leblanc merged commit 0c0fa26 into forefireAPI:masterAug 13, 2026
8 checks passed
Sign up for freeto 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.

2 participants

@HugoFara@antonio-leblanc