docs: refresh README to v0.6.5 surface, tighten CHANGELOG format#12
Merged
Conversation
README was stale at v0.6.0 — still mentioned `/tmp/fledge-gh-*` (changed in v0.6.5) and didn't document any of the write ops (prs comment / review / merge / close), the `repo` subcommand family (file / clone / workspace / workspace-push / workspace-clean), the `-R` flag (added in v0.6.1), or `prs --head` (v0.6.4). Rewrote it to cover the full current surface and added a worked example of the five-step edit-and-PR loop so users can see how the pieces fit together. CHANGELOG: kept the historical record (Keep a Changelog convention), but normalized the formatting — em-dashes between version + date, moved the v0.6.3 free-floating paragraph into a proper summary line above its bullets, lightly tightened v0.6.0 / v0.6.4 / v0.6.5 prose without dropping any content. Also dropped the "Other" section in v0.2.0/v0.2.1 by reclassifying its bullets as Features / Fixes.
|
Warning You have reached your daily quota limit. Please wait up to 24 hours and I will start processing your requests again! |
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
1 participant
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.
Summary
The README had drifted — last meaningfully updated for v0.6.0, still mentioned the old `/tmp/fledge-gh-*` workspace location (changed in v0.6.5), and didn't document any of the write ops (`prs comment`/`review`/`merge`/`close`), the `repo` subcommand family (`file`/`clone`/`workspace`/`workspace-push`/`workspace-clean`), the `-R` flag, or `prs --head`.
Changes
README: rewrote to cover the full current surface as of v0.6.5. Each subcommand block lists actions + options + a few representative examples. New section: a worked example of the five-step edit-and-PR loop (`workspace` → edit → `workspace-push` → `prs create -H` → `workspace-clean`) so users can see how the pieces fit. Updated the "Hacking" note to reflect the current bin/ layout and the actual CI jobs.
CHANGELOG: kept the historical record intact (Keep a Changelog convention), but tightened formatting:
Test plan