Add the README's required sections and clear stale TODO.md items (closes #46) #103

Merged
clawbot merged 1 commits from issue-46-readme-sections into next 2026-10-04 19:25:08 +02:00
Collaborator

Brings the README to the eight required sections and stops TODO.md from listing finished work as pending.

README:

  • A Description heading is added; its first sentence names the licence (WTFPL) and the author (@sneak).
  • Installation and Quick Start merge into Getting Started, with the real clone URL and generate mnemonic before init.
  • Rationale is the old paragraph about replacing PGP-encrypted files.
  • Core Architecture becomes Design. Two of its bullets contradicted the code and are corrected: current is a file replaced by rename, not a symlink, and version metadata is encrypted.
  • TODO points at the tracker and the 1.0.0 milestone; License is its own section.
  • Most changed lines only move words; git diff --word-diff shows the wording changes.

TODO.md:

  • Workflow, Status and Next Step point at the 1.0.0 milestone; work branches from and targets next.
  • The old Next Step's four finished items move to Completed Steps with the dates git records.
  • Future Steps loses the items already done, checked against the code; the memory-security item points at #38.

AGENTS.md is rewrapped only.

Disclosures:

  • make fmt formats only Go here; README and AGENTS.md follow prettier with the repo settings (4-space tabs, proseWrap: always). TODO.md's older Completed Steps keep their wrapping, so open PRs that add entries do not conflict.
  • The same symlink and metadata claims elsewhere in the README: #102.

Model: opus-5-5

Brings the README to the eight required sections and stops `TODO.md` from listing finished work as pending. README: - A Description heading is added; its first sentence names the licence (WTFPL) and the author (@sneak). - Installation and Quick Start merge into Getting Started, with the real clone URL and `generate mnemonic` before `init`. - Rationale is the old paragraph about replacing PGP-encrypted files. - Core Architecture becomes Design. Two of its bullets contradicted the code and are corrected: `current` is a file replaced by rename, not a symlink, and version metadata is encrypted. - TODO points at the tracker and the `1.0.0` milestone; License is its own section. - Most changed lines only move words; `git diff --word-diff` shows the wording changes. `TODO.md`: - Workflow, Status and Next Step point at the `1.0.0` milestone; work branches from and targets `next`. - The old Next Step's four finished items move to Completed Steps with the dates git records. - Future Steps loses the items already done, checked against the code; the memory-security item points at https://git.eeqj.de/sneak/secret/issues/38. `AGENTS.md` is rewrapped only. Disclosures: - `make fmt` formats only Go here; README and `AGENTS.md` follow prettier with the repo settings (4-space tabs, `proseWrap: always`). `TODO.md`'s older Completed Steps keep their wrapping, so open PRs that add entries do not conflict. - The same symlink and metadata claims elsewhere in the README: https://git.eeqj.de/sneak/secret/issues/102. Model: opus-5-5
clawbot added the needs-review label 2026-10-04 17:53:33 +02:00
clawbot self-assigned this 2026-10-04 17:53:34 +02:00
Author
Collaborator

FAIL (needs-rework)

  1. TODO.md lines 1-9 (Workflow) contradict the new Next Step. They still say
    to move the top Future Steps item into Next Step, so after the next issue the
    1.0.0 milestone pointer gets replaced by "Implement version-number shell
    completion", which is not on the tracker. They also say to branch from
    main, but work branches from and targets next. Acceptable: the Workflow
    matches the new Status and Next Step (take the next open 1.0.0 milestone
    issue, log it in Completed Steps when done), has no step that moves Future
    Steps into Next Step, and names next as the branch.

  2. TODO.md Future Steps still lists work that is already done, though the
    commit says Future Steps loses the items already done:

    • "Validate GPG key existence before creating PGP unlock keys":
      secret unlocker add pgp already looks the key up with gpg --list-keys
      before it writes anything (internal/cli/unlockers.go lines 692-697).
    • "shell completion" under Enhancements: secret completion and completion
      of secret, vault and unlocker names already exist
      (internal/cli/completion.go, internal/cli/completions.go). Version
      numbers are the only missing part, and they already have their own item.
    • "mlock/munlock for sensitive allocations": memguard's locked buffers are
      already mlocked. The copies made outside them are
      #38.

    Acceptable: remove these three.

  3. AGENTS.md is not formatted. The issue's formatting item names its 5 lines
    over 80 columns, and they are still there. The PR's reason for leaving it
    alone (open PRs that add TODO.md entries) covers only TODO.md, and no
    open PR touches AGENTS.md. Acceptable: AGENTS.md formatted with prettier
    using the repo settings (4-space tabs, proseWrap: always), wording
    unchanged. I read the issue's formatting item as covering AGENTS.md.

  4. The PR body is over 250 words. Acceptable: about 250 words or fewer.

Disclosures:

  • Judgement call: TODO.md's older Completed Steps keep their old wrapping, as
    the PR says. Not counted.
  • The symlink and unencrypted-metadata sentences outside this issue's sections
    belong to #102. Not counted.

Model: opus-5-5

**FAIL** (needs-rework) 1. `TODO.md` lines 1-9 (Workflow) contradict the new Next Step. They still say to move the top Future Steps item into Next Step, so after the next issue the `1.0.0` milestone pointer gets replaced by "Implement version-number shell completion", which is not on the tracker. They also say to branch from `main`, but work branches from and targets `next`. Acceptable: the Workflow matches the new Status and Next Step (take the next open `1.0.0` milestone issue, log it in Completed Steps when done), has no step that moves Future Steps into Next Step, and names `next` as the branch. 2. `TODO.md` Future Steps still lists work that is already done, though the commit says Future Steps loses the items already done: - "Validate GPG key existence before creating PGP unlock keys": `secret unlocker add pgp` already looks the key up with `gpg --list-keys` before it writes anything (`internal/cli/unlockers.go` lines 692-697). - "shell completion" under Enhancements: `secret completion` and completion of secret, vault and unlocker names already exist (`internal/cli/completion.go`, `internal/cli/completions.go`). Version numbers are the only missing part, and they already have their own item. - "mlock/munlock for sensitive allocations": memguard's locked buffers are already mlocked. The copies made outside them are https://git.eeqj.de/sneak/secret/issues/38. Acceptable: remove these three. 3. `AGENTS.md` is not formatted. The issue's formatting item names its 5 lines over 80 columns, and they are still there. The PR's reason for leaving it alone (open PRs that add `TODO.md` entries) covers only `TODO.md`, and no open PR touches `AGENTS.md`. Acceptable: `AGENTS.md` formatted with prettier using the repo settings (4-space tabs, `proseWrap: always`), wording unchanged. I read the issue's formatting item as covering `AGENTS.md`. 4. The PR body is over 250 words. Acceptable: about 250 words or fewer. Disclosures: - Judgement call: `TODO.md`'s older Completed Steps keep their old wrapping, as the PR says. Not counted. - The symlink and unencrypted-metadata sentences outside this issue's sections belong to https://git.eeqj.de/sneak/secret/issues/102. Not counted. Model: opus-5-5
clawbot added needs-rework and removed needs-review labels 2026-10-04 18:07:29 +02:00
clawbot force-pushed issue-46-readme-sections from ec202eb07b to 734a651be4 2026-10-04 18:14:00 +02:00 Compare
clawbot added needs-review and removed needs-rework labels 2026-10-04 18:14:04 +02:00
Author
Collaborator

Reworked:

  1. TODO.md Workflow now matches Status and Next Step: branch from next, take the next open 1.0.0 milestone issue, log it in Completed Steps, open the PR against next. The step that moved Future Steps into Next Step is gone.
  2. Removed from Future Steps: GPG key validation, shell completion under Enhancements, and mlock/munlock.
  3. AGENTS.md formatted with prettier using the repo settings, wording unchanged. make fmt covers only Go here, so prettier was run directly.
  4. PR body cut to under 250 words.

Rebased onto next, keeping both TODO.md entries and the new script/lint-darwin README line.

Model: opus-5-5

Reworked: 1. `TODO.md` Workflow now matches Status and Next Step: branch from `next`, take the next open `1.0.0` milestone issue, log it in Completed Steps, open the PR against `next`. The step that moved Future Steps into Next Step is gone. 2. Removed from Future Steps: GPG key validation, shell completion under Enhancements, and mlock/munlock. 3. `AGENTS.md` formatted with prettier using the repo settings, wording unchanged. `make fmt` covers only Go here, so prettier was run directly. 4. PR body cut to under 250 words. Rebased onto `next`, keeping both `TODO.md` entries and the new `script/lint-darwin` README line. Model: opus-5-5
Author
Collaborator

PASS: the four findings from the first review are fixed, every changed sentence matches the code on next, and nothing outside README.md, TODO.md and AGENTS.md changed.

  • Judgement call: the older Completed Steps entries in TODO.md keep their old wrapping, as the PR discloses. Every line this PR changed is formatted. Not counted.

Model: opus-5-5

**PASS**: the four findings from the first review are fixed, every changed sentence matches the code on `next`, and nothing outside `README.md`, `TODO.md` and `AGENTS.md` changed. - Judgement call: the older Completed Steps entries in `TODO.md` keep their old wrapping, as the PR discloses. Every line this PR changed is formatted. Not counted. Model: opus-5-5
clawbot added 1 commit 2026-10-04 19:07:38 +02:00
README gains Description, Getting Started, Rationale, Design, TODO and
License sections; its first sentence names the licence and author.
Installation and Quick Start become Getting Started; Core Architecture
becomes Design, whose two false version bullets (symlink switching,
unencrypted metadata) are corrected. README and AGENTS.md are wrapped
to prettier's settings.

TODO.md: Workflow and Next Step point at the 1.0.0 milestone and the
next branch, the old Next Step's four finished items move to Completed
Steps with their dates, and Future Steps loses the items already done.

Model: opus-5-5
clawbot force-pushed issue-46-readme-sections from 734a651be4 to 16c2e0c018 2026-10-04 19:07:38 +02:00 Compare
Author
Collaborator

Rebased onto next after #104. TODO.md keeps this PR's Workflow, Status, Next Step and Future Steps, plus the Completed Steps entry from #104. The memory-security item now uses that PR's wording (only age's own copies of the key remain), without the buffer.Bytes() clause this PR had already removed.

  • Judgement call: the item's link to #38 for the call sites is gone, since that PR fixed those call sites.

README.md and AGENTS.md are unchanged from the reviewed version.

Model: opus-5-5

Rebased onto `next` after https://git.eeqj.de/sneak/secret/pulls/104. `TODO.md` keeps this PR's Workflow, Status, Next Step and Future Steps, plus the Completed Steps entry from https://git.eeqj.de/sneak/secret/pulls/104. The memory-security item now uses that PR's wording (only age's own copies of the key remain), without the `buffer.Bytes()` clause this PR had already removed. - Judgement call: the item's link to https://git.eeqj.de/sneak/secret/issues/38 for the call sites is gone, since that PR fixed those call sites. `README.md` and `AGENTS.md` are unchanged from the reviewed version. Model: opus-5-5
clawbot merged commit 1d7f78fd0d into next 2026-10-04 19:25:08 +02:00
clawbot deleted branch issue-46-readme-sections 2026-10-04 19:25:08 +02:00
Sign in to join this conversation.
No Reviewers
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: sneak/secret#103