Uh oh!
There was an error while loading. Please reload this page.
Add a CHANGELOG - #184
Merged
antonio-leblanc merged 1 commit intoAug 13, 2026
Merged
Conversation
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.
Uh oh!
There was an error while loading. Please reload this page.
This was referenced Aug 13, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The repository has seven tags and six GitHub releases, and no file that tells a user what changed between them.
pip install forefiresharpened 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 Changeloglink on each version gives the complete range.Where a claim could be checked against the tags, it was:
listenHTTPis new in v2.0v1.2, present atv2.0RothermelAndrews2018is new in v2.0v1.2, present atv2.0geojsondump mode is new in v1.2v1.1.10v2.1.122is 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 devmasterisv2.5.0plus #154 and #155, so those two are all that appears.devcarries 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.mdlinked to a testing page that has never existed, atreadthedocs.io/en/latest/developer_guide/testing.html, marked(Placeholder: Link to testing section once created). It points atTESTING.md, which until now nothing in the repository linked to at all.README.mdKey Links gains the changelog andTESTING.md.Not done here
CONTRIBUTING.mdstill says to verify withcd tests && bash run.bashnext to "Ensure all tests pass locally". On this branch that instruction fails:tests/run.bashrunsrunANN, which has been broken since it was committed. The fix is #183, which is ondev, and the corrected wording travels with it — documenting a working command here would have been documenting somethingmastercannot do yet.The wider documentation audit that produced this — the Read the Docs site never mentioning
pip,tests/README.mdnaming files that do not exist, theemitcommand 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.