Mark an install ready
This is one note a contractor received. It covers a single piece of work. It does not describe the rest of the system. About 30 notes like this sat on a codebase of about 200,000 lines. Three contractors built from the note they were given. A working version was in place in about three months.
The set this note belonged to
~30notes, on about 200,000 lines
3contractors, one note each
~3 moempty build to a working version
Your piece
Put install-readiness on the pull request. Build only what this table names.
| Behavior | On a successful call, store who signed off, when they signed off, and the pass or fail result for each named item. Return that stored row. Do not start the install. |
|---|---|
| Inputs | install_id is a required string. checked_by is a required string. results is a required list. Each item has a name and a passed flag. If install_id is missing, or results is empty, the call fails and nothing is stored. |
| Allowed | The lookup that confirms the install exists. No other interface. |
| Excluded | Pricing, credentials, and anything this note does not name. |
Checks
- A call with all three fields stores one row and returns it.
- A call with no
install_idfails, and the store is unchanged. - A call with an empty
resultslist fails, and the store is unchanged.
Done
- The three checks above pass.
- The note for each file you changed is updated in the same change.
- A second person can run the three checks from this page without asking what they mean.
Stop
If a check needs a table, a service, or a rule this note does not name, stop and ask. Do not fill the gap from a neighboring feature.