flagon-io/g1t

Pick any line to see why it is the way it is: the commit, the pull request and issue it came from, and what the agent was thinking.

Actions: reusable workflows in the repository9d ago		1	# Contributing to g1t
		2
		3	g1t is built the way it asks others to build: issues and pull requests on
Fast pages, required checks on the branch, self-hosted runners, honest incidents6d ago		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.
Actions: reusable workflows in the repository9d ago		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/` |
Merge branch 'worktree-agent-ab2e39e11a6493412'7d ago		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. |
g1t is one name: its agent's work, commits and comments show as @g1t, and nobody can claim g1t or g1t-agent6d ago		17	| How agents behave | `guides/working-with-g1t.md`, and `apps/web/public/llms.txt` |
Actions: reusable workflows in the repository9d ago		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
Invite-only launch: sign in with GitHub, repository access and lifecycle, many emails, a new look6d ago		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
CONTRIBUTING says how the site's interface is built: from the shadcn components in apps/web/app/components/ui, themed with g1t's tokens, adding a missing one there first, changing looks through variants rather than one-off class strings, and looking at every changed page in both themes on a desktop and a phone.2d ago		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
Actions: reusable workflows in the repository9d ago		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.
Deploys as code: a manifest of every Worker, a deploy tool that ships only what changed in parallel stages, and a g1t Actions workflow6d ago		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
The docs folder is gone, and what it held lives where people read it: how a self-hosted g1t runs and how to deploy g1t to Cloudflare are pages on docs.g1t.sh under Run g1t yourself, and speed, rate limits and operating g1t.sh are sections of CONTRIBUTING.md; code that cited a file in docs/ now points to the page or section that covers it, or says what it means itself, and applied migrations and the runner images are left as they were.2d ago		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
		113	## Rate limits
		114
		115	`RATE_LIMITS` in `packages/contracts/src/rate-limits.ts` is the table of
		116	record, and the [rate limits page](https://docs.g1t.sh/reference/rate-limits/)
		117	is the public one: change both, and the binding in the Worker's
		118	`wrangler.jsonc`, together (`front-door-limits.test.ts` fails when they
		119	disagree). Limits fail open, keys hash anything secret, and each Worker
		120	takes its namespace ids from its own block of a hundred (41xx packages,
		121	42xx web, 43xx repos, 44xx api, 45xx og, 46xx status).
		122
		123	## Operating g1t.sh
		124
		125	For Flagon staff.
		126
		127	- **Incidents** are declared, updated and resolved in sudo, under
		128	**Platform → Incidents**, and appear on status.g1t.sh within 30 seconds.
		129	Declare as soon as people are affected, and pick the higher severity
		130	when unsure. SEV1 (down for most people, or data at risk) gets an update
		131	at least every 30 minutes and SEV2 (a core part broken for many) at least
		132	hourly; both email subscribers and need a blameless postmortem within
		133	five working days.
The artifacts service is services/artifacts, the Worker g1t-artifacts, bound as ARTIFACTS by the API, the site and the agents; its live rooms move to it with a Durable Object transfer from g1t-docs-service, and its database, bucket, indexes and queue keep their names. The git store's binding and settings are GITSTORE, its ops scripts gitstore-*, and workflow run artifacts keep their compatible API under run_artifacts modules. The deploy tool puts a Worker that has never deployed before the Workers in its stage that bind to it, and the deploy guide gives the cutover runbook.2d ago		134	- **An Artifacts outage:** `scripts/ops/gitstore-namespaces.mjs` shows a
The docs folder is gone, and what it held lives where people read it: how a self-hosted g1t runs and how to deploy g1t to Cloudflare are pages on docs.g1t.sh under Run g1t yourself, and speed, rate limits and operating g1t.sh are sections of CONTRIBUTING.md; code that cited a file in docs/ now points to the page or section that covers it, or says what it means itself, and applied migrations and the runner images are left as they were.2d ago		135	failing namespace. After 15 minutes, serve it read-only from the fallback
		136	git store (`scripts/ops/restore-to-gitstore.mjs restore`, then the repos
		137	Worker's secret `GIT_FALLBACK_NAMESPACES`) and open an incident. To
		138	switch back, `reconcile` anything the fallback took, then delete the
		139	secret. The script's header has every step.
		140	- **Costs and margin**, model prices, credits and the platform pause are
		141	in sudo, under **Costs & margin**. The code is in `services/billing/src`
		142	(`costs.rs`, `margin.rs`, `pricing.rs`, `budget.rs`, `platform.rs`).

This file's history is long; its oldest lines are credited to the oldest commit read.