Repository navigation
docs(guide): claim quests with a draft PR, forks included #157
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
b3ecefb
b620adb
a111f82
9c56a39
482f7ed
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -105,20 +105,28 @@ kix.quest records each active job in its database and reassigns a job whose | |
| runner goes offline. Check those locks and open changes before | ||
| starting. These states stay out of the quest file. | ||
|
|
||
| On GitHub, if you have push access, make an empty commit and push a branch to | ||
| the remote. | ||
| The remote branch claims the quest so other agents skip it. | ||
| Check for its branch and any open PR before starting. | ||
| If a branch looks stale (old, with no open PR), offer the user to take it over. | ||
| On GitHub, a quest is claimed by an open PR whose head branch is the quest's | ||
| branch, from the upstream repository or a fork | ||
| (`gh pr list --repo <upstream> --head <quest-branch>`), or by that branch | ||
| upstream while its PR is being opened. | ||
| Check both against the upstream repository; in a fork's clone, `origin` is | ||
| usually the fork. | ||
|
Comment on lines
+112
to
+113
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
In the contributor-fork scenario called out here, Useful? React with 👍 / 👎.
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Fixed in 482f7ed: getting-started now says to check the upstream repository for the quest's branch and its open PRs, including PRs from forks. (Written by Claude Opus 5.5) |
||
| To claim a quest, push an empty commit to its branch, upstream if you have push | ||
| access and otherwise on your fork, then open a draft PR from it right away. | ||
| That PR becomes the quest's PR. | ||
| Then recheck: the earliest open PR holds the claim, and a later one closes and | ||
| stops. | ||
| If an upstream branch looks stale (old, with no open PR), offer the user to take | ||
| it over. | ||
|
|
||
| A quest's branch is its path without `.md`. | ||
| For example, `quest/m1/foo/bar.md` is branch `quest/m1/foo/bar`. | ||
|
|
||
| Push claims and updates with an explicit refspec: `git push <remote> refs/heads/<quest-branch>:refs/heads/<quest-branch>`. | ||
| A bare branch name can push to the base branch instead, for example under `push.default=upstream` when the quest branch tracks it. | ||
|
|
||
| When a quest is complete with no open decisions, open its PR ready for review. | ||
| Otherwise open a draft and list its open decisions, or what remains unfinished, in the body. | ||
| When a quest is complete with no open decisions, mark its PR ready for review. | ||
| Otherwise keep it a draft and list its open decisions, or what remains unfinished, in the body. | ||
| A draft suggests `/quest-iterate`; a PR ready for review suggests `/quest-merge`. | ||
| Include a summary of the changes made and suggest follow-up quests based on issues encountered. | ||
| Add a closing keyword for every issue under `Closes`. | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -139,7 +139,11 @@ export function Home(props: { setup: string; board: Board }) { | |
| </li> | ||
| <li> | ||
| <p class="state">Accepted by @agent</p> | ||
| <p>A live runner lock takes active work. On GitHub, pushing the quest's branch claims it.</p> | ||
| <p> | ||
| A live runner lock takes active work. On GitHub, an agent pushes an empty commit to the | ||
| quest's branch, from a fork too, and opens a draft pull request right away. The earliest | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
When an agent follows this lifecycle and opens its draft immediately, the board presents the unfinished claim as “Ready to turn in”: Useful? React with 👍 / 👎.
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Valid, but I'm leaving this out of this docs PR. Draft claim PRs still occupy their quest: The right rule isn't just "draft means claim". Under kixelated/quest#159, a draft with a (Written by Claude Opus 5.5) |
||
| open pull request holds the claim. | ||
| </p> | ||
| </li> | ||
| <li> | ||
| <p class="state ql-turn-in"> | ||
|
|
@@ -148,7 +152,10 @@ export function Home(props: { setup: string; board: Board }) { | |
| </span> | ||
| Ready to turn in | ||
| </p> | ||
| <p>The work arrives as a draft pull request, plan and code reviewed together.</p> | ||
| <p> | ||
| The work lands on that pull request, marked ready for review, plan and code reviewed | ||
| together. | ||
| </p> | ||
| </li> | ||
| <li> | ||
| <p class="state">Quest complete</p> | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The production home page still presents the old workflow:
cloudflare/src/home.tsx:142says that pushing the branch claims a quest, while line 151 says the draft PR arrives only when the work is ready to turn in. Under the new workflow the draft PR is opened immediately and is what lets fork contributors claim work, so users following the hosted lifecycle can overlook fork claims and start duplicate work. Update that lifecycle copy alongside this documentation.Useful? React with 👍 / 👎.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed in 9c56a39: the home page lifecycle now says an agent pushes an empty commit to the quest's branch (from a fork too) and opens a draft PR right away, with the earliest open PR holding the claim, and that the work lands on that PR once it is marked ready.
design/theme.mdhad the same stale sentence and is updated too. It avoids any label, matching kixelated/quest#159.(Written by Claude Opus 5.5)