Repository navigation
Professional changelog (Keep a Changelog), README, CLI help and troubleshooting - #153
Merged
Merged
Conversation
Summary line, then Added, Changed, Fixed and Compatibility and limits, with short bullets and issue numbers. The full text of the 31 entries moves unchanged to docs/releases/0.6.0.md, linked from the changelog.
The changelog's link to docs/releases/0.6.0.md is a full GitHub URL: the docs site includes CHANGELOG.md, where a relative link does not resolve and the strict build failed. CONTRIBUTING describes the release structure and tests/test_changelog.py enforces it for Unreleased and every release from 0.6.0 on.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #153 +/- ##
=======================================
Coverage 89.81% 89.81%
=======================================
Files 54 54
Lines 7367 7367
=======================================
Hits 6617 6617
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:
|
Owner
Author
|
Note: the last commit described above (Keep a Changelog for every release, README, CLI help, troubleshooting) was pushed after this PR was merged, so it did not reach main. It is in a new PR: see the PR from branch docs/professional-docs. |
rafatahmed
added a commit
that referenced
this pull request
Oct 23, 2026
Professional changelog (Keep a Changelog), README, CLI help and troubleshooting (missed commit of #153)
rafatahmed
added a commit
that referenced
this pull request
Nov 7, 2026
Structure the 0.6.0 changelog like earlier releases
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.
The owner asked for a professional format, following the standards, for the changelog (every release), the README, the CLI help, and troubleshooting for upgrades. Each part follows a published standard.
Changelog: Keep a Changelog 1.1.0, every release
## [Unreleased]comes first;## [X.Y.Z] - YYYY-MM-DD; 0.3.0 is marked[YANKED]; 0.6.0 reads- not yet releaseduntil the finalize step dates it;docs/releases/0.5.0.md,0.4.0.mdand0.3.1.md, alongside0.6.0.mdand0.3.0.md.tests/test_changelog.pychecks every release: headings, types, bullet length, grouping and links. It finds 28 problems in the previous changelog;CLI help: Command Line Interface Guidelines
flahax --helpgives:flahax batchexample that was run to confirm it works;--interactiveis described in the same style as the other options.flahax) links the documentation.test_help_describes_every_command_with_examples_and_linksfailed before the change.Troubleshooting
--upgradetrap from GitHub (Upgrading from main with pip --upgrade keeps the old files while the version stays 0.6.0.dev0 #134) and--force-reinstall;flahaxnot on PATH after a user installation (python -m flahax); two Pythons.flahax mix: line-by-line instead of full screen, a small window, a copy older than 0.6.0, typing "à" (mix TUI on Windows: typing "à" swallows the next key #127),?symbols, and the leave confirmation.README: PyPA, PyPI-friendly README
flahax mix,flahax batch, Python), commands, what it does, documentation, troubleshooting, verification and limits (with the roadmap), contributing (with the code of conduct and security policy), citation, credits, license.twine check --strictpasses on the built wheel and sdist.Also in this PR
Checks