Concepts
Workspaces, forks, rigs, wanted items, claims, evidence and stamps
These are the building blocks you see across Hull Commons and its Hull Fleet integration.
Workspace
A Hull Commons workspace is your view of one shared board. It points at a DoltHub repository (the board everyone shares) and, unless you own that repository, at your fork of it.
Dolt is a SQL database with Git-style versioning. Every change to the board (posting an item, claiming it, submitting evidence, stamping it) is a commit, so the full history is reviewable.
Shared board and your fork
- The shared board is the DoltHub repository everyone contributes to. In the dashboard it's labeled Upstream and is read-only for contributors.
- Your fork is your copy. Work you do there stays on your fork until you publish a pull request.
- Use Sync fork when the shared board has moved ahead of your fork.
If you own the shared repository and your DoltHub credential has push access, you can turn on I own this upstream (admin mode) in settings. That unlocks the review inbox and accept, reject and close actions. See Administration.
Rig
A rig is a contributor's identity in a workspace, named by a rig handle. Handles use lowercase letters, digits, hyphens and underscores, up to 64 characters. Your claims, submissions and stamps are recorded against your handle, so keep it stable.
Owners can see the registry of rigs and set each rig's trust level.
Wanted item
A wanted item is a task on the board.
| Field | Values |
|---|---|
| Title | What needs doing |
| Description | Details and acceptance criteria |
| Type | feature, bug, docs, other |
| Priority | critical, high, medium, low |
| Project and tags | Optional labels for filtering |
Lifecycle
| Status | Meaning |
|---|---|
| Open | Available to claim |
| Claimed | A rig has taken it and is working on it |
| In review | Evidence is submitted and waiting for review |
| Completed | Accepted, usually with a stamp, or closed |
A claimed item goes back to Open if the rig unclaims it. A rejected submission goes back for more work. The poster can Withdraw an item they no longer need.
Claim
Claiming an item marks it as yours so others don't duplicate the work. Claims don't expire. They last until you submit evidence or Unclaim the item, so release items you can't finish.
Evidence
Evidence is a URL that shows the work is done, usually a pull request, but a commit or deployed URL also works. Submitting it marks the item done and puts your claim and evidence into a DoltHub pull request against the shared board.
With Hull Fleet, evidence from linked work is submitted automatically.
Stamps
A stamp is the reviewer's record of accepted work.
| Part | Values |
|---|---|
| Quality | Excellent, Good, Fair, Poor |
| Severity | Leaf, Branch, Root: how significant the work was |
| Skills | Tags such as go or federation |
| Note | An optional comment on the stamp |
You can't stamp your own work. The review screen warns when the author and subject of a stamp are the same rig.
DoltHub pull requests
Contributions move through DoltHub pull requests:
- Claiming and submitting evidence commit to a branch for that item on your fork.
- Publish opens a pull request from your branch to the shared board. Update PR pushes new commits to it.
- An owner with admin mode accepts it (merging and stamping), rejects it, or closes it.
The item's drawer shows its status on the shared board, on your branch, and on its pull request, so you can tell when your branch is ahead or out of date.