Sign in

Search issue titles and bodies, change requests and comments. Private repositories you cannot read are not included.

vole
Clone

Read only, no credentials:

https://rodent.software/git/vole.git

Write over SSH with a registered key:

git clone ssh://git@0.0.0.0:2222/vole.git

A free and open-source forge that lives in your Git repo.

Document how a change request links the issues it closes `vole change new` and `vole change update` take `--closes`, and the request's metadata is what the page shows and what landing the request closes. None of the guides said so: `docs/cli.md` listed neither flag, `docs/change-requests.md` never mentioned the field, and `CONTRIBUTING.md` showed the opening command without it.

a0a7c73a67594f772ad9796dc570d81a68e5ab63 · Keenan Nemetz · 13d ago · parent c765ae2e

Document how a change request links the issues it closes
`vole change new` and `vole change update` take `--closes`, and the
request's metadata is what the page shows and what landing the request
closes. None of the guides said so: `docs/cli.md` listed neither flag,
`docs/change-requests.md` never mentioned the field, and `CONTRIBUTING.md`
showed the opening command without it.

That gap has a cost beyond being incomplete: a description that says
`Fixes #<ulid>` looks like it links the issue, so a request can land
without closing the issue it was meant to fix, and nobody notices until
the issue is still open on a merged change.

The workflow guide now has a section on the link — set it at open or
while the request is open, replaced rather than appended, full ids that
must exist, and only landing closes — the command reference lists the
flags, and CONTRIBUTING points at `--closes` and says the prose form is
only text.

CONTRIBUTING.md +8−1

@@ -97,11 +97,18 @@ git push -u origin <branch>
97 97 Then open a Vole change request if the branch should be reviewed:
98 98
99 99 ```sh
100 ./vole change new --title "..." --base main --head <branch> -F /tmp/change-body.md
100 ./vole change new --title "..." --base main --head <branch> \
101 --closes <full-ulid> -F /tmp/change-body.md
101 102 ./vole change list --state open --format '%(id) %(title)'
102 103 ./vole change show <full-id>
103 104 ```
104 105
106 Link the issue with `--closes <full-ulid>` (repeatable) when the branch fixes
107 one. That field is what the request page shows and what landing the request
108 closes; `Fixes #<ulid>` in the description is only text. A link may be added or
109 replaced later with `./vole change update <full-id> --closes <full-ulid>` while
110 the request is open.
111
105 112 Important differences from a GitHub-style forge:
106 113
107 114 - The `vole` metadata branch is maintained by Vole. Do not hand-edit it or