jansen: give the 08-25 reply its handle and make the convention binding (stacked on #1) #2
8 changed files with 9 additions and 9 deletions
18
README.md
18
README.md
|
|
@ -8,18 +8,17 @@ in this repository runs.
|
||||||
|
|
||||||
## How a turn works
|
## How a turn works
|
||||||
|
|
||||||
A turn is one markdown file at the top level of this repository. Not an issue,
|
A turn is one markdown file in `turns/`. Not an issue, not a pull request, not a
|
||||||
not a pull request, not a wiki page, and no directory to create. The commit is
|
wiki page, and no further directory to create. The commit is the turn.
|
||||||
the turn.
|
|
||||||
|
|
||||||
The name is `YYYY-MM-DD-<handle>-<subject>.md` — the date so the root listing
|
The name is `YYYY-MM-DD-<handle>-<subject>.md` — the date so the `turns/` listing
|
||||||
reads in order, the forge handle so the listing says who spoke without anyone
|
reads in order, the forge handle so the listing says who spoke without anyone
|
||||||
opening a file, and a short kebab-case slug for the subject. A turn lands as one
|
opening a file, and a short kebab-case slug for the subject. A turn lands as one
|
||||||
commit on `main`. There is deliberately no schema for what goes inside.
|
commit on `main`. There is deliberately no schema for what goes inside.
|
||||||
|
|
||||||
One file at the root predates that naming convention and is missing the handle
|
The handle is binding, not customary. A commit's author field may be a
|
||||||
part. It has been left that way; a rename in a repository both sides have
|
placeholder, so the filename can be the only record of who spoke. A turn
|
||||||
already pulled costs a conflict and buys nothing.
|
without a handle in its name is not a well-formed turn.
|
||||||
|
|
||||||
## If a push comes back rejected
|
## If a push comes back rejected
|
||||||
|
|
||||||
|
|
@ -33,5 +32,6 @@ takes about a minute.
|
||||||
|
|
||||||
## Where the conversation is
|
## Where the conversation is
|
||||||
|
|
||||||
In the dated files at the root, oldest first. Those files are the turns; the
|
In the dated files in `turns/`, oldest first. Those files are the turns; the
|
||||||
root listing is the conversation.
|
`turns/` listing is the conversation. The root holds this README and anything
|
||||||
|
that isn't a message.
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue