flagon-io/g1t

public

1	# Contributing to g1t
2
3	g1t is built the way it asks others to build: issues and pull requests on
4	[g1t.sh/flagon-io/g1t](https://g1t.sh/flagon-io/g1t), required checks that prove
5	a change works, and a merge queue that keeps `main` passing.
6
7	## A change ships with its docs
8
9	Documentation is part of the product, held to the same bar as the code.
10	A pull request that changes what someone can do, see or call changes the
11	docs in the same pull request:
12
13	\| If you change \| Update \|
14	\| --- \| --- \|
15	\| Something a person does on g1t.sh \| The guide for it in `apps/docs/src/content/docs/guides/` \|
16	\| An API route, a field, or an MCP tool \| `apps/api/src/operations.rs` descriptions (they feed the OpenAPI document and the API reference), the example and notes for it in `apps/api/src/reference.json`, `reference/mcp.md`, and any guide that shows the call. Then refresh the docs' copy of the OpenAPI document with `G1T_WRITE_OPENAPI=1 cargo test -p g1t-api openapi`; `cargo test` fails until you do. \|
17	\| How agents behave \| `guides/working-with-g1t.md`, and `apps/web/public/llms.txt` \|
18	\| Settings, limits or prices \| The page that names them, and the table it is in \|
19	\| A new feature \| A section in the guide that owns it, linked from the docs home if it is a new task \|
20
21	The style, in short: plain sentences, second person, no marketing words,
22	sentence-case headings, a numbered list for steps, a table for options, and
23	every API mention with its exact route or tool name. Examples are copyable
24	and real. Nothing is documented that the code does not do.
25
26	Check the docs build before you push:
27
28	```sh
29	cd apps/docs && npm run build
30	```
31
32	## Icons
33
34	- Interface icons come from [Lucide](https://lucide.dev/icons). In the
35	apps, import them from `lucide-react`. In the docs, use `@lucide/astro`:
36	import an icon component, or give `apps/docs/src/components/Card.astro`
37	and `Aside.astro` a Lucide name such as `icon="git-branch"`. Starlight's
38	own `<Card>`, `<LinkCard>` and `<Aside>` draw Starlight's icon set, so the
39	docs import the wrappers in `apps/docs/src/components/` instead.
40	- Brand marks come from [Simple Icons](https://simpleicons.org)
41	(`simple-icons`), and follow each brand's own usage guidelines. Add the
42	dependency with the first one you show.
43	- The g1t logo and illustrations are our own artwork, in
44	`apps/web/app/components/logo.tsx` and `art.tsx`.
45	- Never hand-copy an icon's SVG paths into a file. If Lucide lacks the
46	icon you need, pick the closest one that it has.
47
48	## Interface components
49
50	- Build the site from the components in `apps/web/app/components/ui`,
51	which are [shadcn/ui](https://ui.shadcn.com) components themed with
52	g1t's tokens: buttons, cards, badges, tables, tabs, separators,
53	breadcrumbs, menus, dialogs, sheets, tooltips, form controls.
54	- If shadcn has a component you need and `ui` doesn't, add it there
55	first, themed with the tokens, then use it. Don't rebuild it inline.
56	- Change how something looks through the component's variants, not
57	with a one-off class string at the call site. A long `className` on a
58	`div` that draws a card, a pill or a button is a component that should
59	exist.
60	- Hover hints use the `Tooltip` component, never `title=`. Native
61	`<select>`, file inputs, checkboxes and radios use their `ui`
62	components.
63	- Look at every page you change, in light and dark, on a desktop and a
64	phone, before calling it done.
65
66	## Before you push
67
68	- `cargo test` in the crate or service you changed.
69	- `npx tsc -b --force` in `apps/web` (the incremental build misses changes
70	in `packages/contracts`).
71	- Look at what you changed in a browser. Screenshots catch what type
72	checks do not.
73
74	## Deploying
75
76	Pushes to `main` deploy themselves: `.g1t/workflows/deploy.yml` runs
77	`scripts/deploy.mjs`, which deploys only the parts that changed, migrations
78	first. Every deployable part is listed in `deploy/stack.jsonc`; a new service
79	or app goes there, and in the table on
80	[How a self-hosted g1t runs](https://docs.g1t.sh/guides/self-hosting-architecture/#each-part)
81	(`npm run test:deploy` says what is missing).
82	[Deploy g1t to Cloudflare](https://docs.g1t.sh/guides/deploy-to-cloudflare/)
83	covers the tool, the workflow, rollbacks, adding a unit and first-time
84	setup.
85
86	- Migrations run before the code, so the old code reads the new schema
87	for a minute or more. Add tables and columns; change what rows mean in
88	two deploys (code that reads both forms first); never drop what live code
89	still reads.
90	- The self-hosted runner is released, not deployed: bump `version` in
91	`crates/runner/Cargo.toml`, merge, and push a `runner-v<version>` tag.
92	`.g1t/workflows/runner-release.yml` builds, signs and publishes it, and
93	runners update themselves to it. `scripts/runner-release.mjs` does the
94	same by hand.
95
96	## Speed
97
98	Pages are a few rounds of service calls, and each round costs a trip to
99	the databases, so start calls together and add no rounds.
100
101	- Every page answers with `Server-Timing`: each loader, each service's
102	calls and their database time. Look at it in DevTools when a page feels
103	slow.
104	- `scripts/perf/measure.ps1` times pages from your machine (`-BrowserUA`
105	for signed-out pages as a browser sees them). A page that only reads
106	must not set the `g1t_d1` cookie: a new read-only service method goes in
107	`READS` in `apps/web/app/lib/perf.ts`.
108	- Targets from the US: signed-out pages under 200 ms to first byte,
109	signed-in pages under 400 ms, streamed panels within a second.
110	- Workers run without Smart Placement; `scripts/perf/placement-probe.mjs`
111	measures a placement before you pin one.
112	- A TypeScript service reports its database time too (`db;dur`, from
113	`openD1` in `@g1t/contracts`): the round trips a method makes are what
114	it costs, so start them together (`Promise.all`), keep what never
115	changes across requests in the isolate (the artifacts service keeps a
116	workspace's slug for 30 s and whether its General space exists), and
117	don't wake a Durable Object for a read D1 can answer.
118	- Nothing live gates a page. A page carries what it shows (a doc's text
119	and its saved document), opens its sockets as it hydrates rather than
120	from inside the code they feed, keeps what is typed until they answer,
121	and says so with a dot, never a spinner. A page opened with an access
122	token gets its socket tickets with the page (the root loader mints the
123	feed's, an artifact's loader its room's) rather than asking for each.
124	- Code that only the browser runs (the doc editor) is still fetched with
125	the page: `vite.config.ts` notes the chunk and what it imports for the
126	route's `links`, and a link to such a page warms the chunk on hover.
127	Modules several routes share are grouped by who shares them
128	(`codeSplitting.groups`), so a page fetches tens of files, not a
129	hundred and more. Before this, opening a doc fetched 124 files
130	(1,049 KB) in three waves and the editor appeared at 2.8–3.3 s; a doc
131	now fetches 71 files (1,026 KB) in one wave, and against the deployed
132	services the editor appears at 2.1 s, of which the room's answer is
133	0.65 s and the editor's own start 0.4 s. The room's part (the saved
134	document in the page, one call to the room, the context in one round)
135	is measured after deploy.
136
137	## Rate limits
138
139	`RATE_LIMITS` in `packages/contracts/src/rate-limits.ts` is the table of
140	record, and the [rate limits page](https://docs.g1t.sh/reference/rate-limits/)
141	is the public one: change both, and the binding in the Worker's
142	`wrangler.jsonc`, together (`front-door-limits.test.ts` fails when they
143	disagree). Limits fail open, keys hash anything secret, and each Worker
144	takes its namespace ids from its own block of a hundred (41xx packages,
145	42xx web, 43xx repos, 44xx api, 45xx og, 46xx status).
146
147	## Operating g1t.sh
148
149	For Flagon staff.
150
151	- Incidents are declared, updated and resolved in sudo, under
152	Platform → Incidents, and appear on status.g1t.sh within 30 seconds.
153	Declare as soon as people are affected, and pick the higher severity
154	when unsure. SEV1 (down for most people, or data at risk) gets an update
155	at least every 30 minutes and SEV2 (a core part broken for many) at least
156	hourly; both email subscribers and need a blameless postmortem within
157	five working days.
158	- An Artifacts outage: `scripts/ops/gitstore-namespaces.mjs` shows a
159	failing namespace. After 15 minutes, serve it read-only from the fallback
160	git store (`scripts/ops/restore-to-gitstore.mjs restore`, then the repos
161	Worker's secret `GIT_FALLBACK_NAMESPACES`) and open an incident. To
162	switch back, `reconcile` anything the fallback took, then delete the
163	secret. The script's header has every step.
164	- Costs and margin, model prices, credits and the platform pause are
165	in sudo, under Costs & margin. The code is in `services/billing/src`
166	(`costs.rs`, `margin.rs`, `pricing.rs`, `budget.rs`, `platform.rs`).