Repository navigation
Professional changelog (Keep a Changelog), README, CLI help and troubleshooting (missed commit of #153) - #154
Merged
Merged
Conversation
- CHANGELOG.md follows Keep a Changelog 1.1.0 for every release: [Unreleased] first, "## [X.Y.Z] - YYYY-MM-DD" headings ([YANKED] for 0.3.0), the six change types, short bullets, and comparison links. The full text of 0.5.0, 0.4.0 and 0.3.1 moves unchanged to docs/releases/. tests/test_changelog.py enforces the format; CONTRIBUTING states it. - flahax --help describes every command, with examples and links to the documentation and the issue tracker (clig.dev); the start screen links the documentation. - The user guide gains troubleshooting for installing and upgrading (#134) and for the full-screen flahax mix; the README links it. - The README follows the order a reader needs: installation, quick start (flahax mix, flahax batch, Python), commands, what it does, documentation, troubleshooting, verification and limits, contributing, citation, credits, license. twine check --strict passes.
rafatahmed
marked this pull request as draft
October 23, 2026 20:26
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #154 +/- ##
=======================================
Coverage 89.81% 89.82%
=======================================
Files 54 54
Lines 7367 7371 +4
=======================================
+ Hits 6617 6621 +4
Misses 750 750
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
rafatahmed
marked this pull request as ready for review
October 23, 2026 20:41
rafatahmed
added a commit
that referenced
this pull request
Nov 7, 2026
Professional changelog (Keep a Changelog), README, CLI help and troubleshooting (missed commit of #153)
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 free
to 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.
This carries the last commit of #153, which reached the branch after #153 had been merged and closed, so it is not on
mainyet. The commit is unchanged (cherry-picked onto the currentmain). The description of #153 covers it in full; in short:## [Unreleased]comes first, and every release is headed## [X.Y.Z] - YYYY-MM-DD(0.3.0 is[YANKED]).docs/releases/.tests/test_changelog.pychecks every release, and CONTRIBUTING states the rule.flahax --helpdescribes every command, with examples and links to the documentation and the issue tracker; the start screen links the documentation. Behaviour is unchanged.flahax mix; the README links it.twine check --strictpasses.Checks
mainbase: the changelog, CLI, release-hygiene, error-catalogue and manifest tests and the strict docs build pass again.