Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .claude/skills/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ required to build or run the app. Start with `CONTRIBUTING.md` for dependencies
and verification; use whatever terminal, browser or native-window tools your
agent environment provides.

Follow `AGENTS.md` for issue tracking: internal and contributor work both use
this repository's GitHub Issues, not Linear.

| Skill | Purpose | Requirements beyond the contributor setup |
| --- | --- | --- |
| `bus-live-test` | Exercise bot messaging and guardrails | Node 22+; real Claude sessions require consent and an authenticated CLI |
Expand Down
2 changes: 1 addition & 1 deletion .claude/skills/release/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ cargo update --workspace --offline
`@xterm/addon-web-links` dependency, not ours. Leave it.

Commit as `chore(release): bump version to X.Y.Z`, open the PR against `main`
with the usual What/Why/How tested body and link the primary issue. Before
with the usual What/Why/How tested body and link the primary GitHub issue (`#123`). Before
pushing, run `pnpm run verify` (typecheck, tests, lint, builds and visual checks).
Regenerate dependency notices with `pnpm notices:generate` when versions or
lockfiles change; follow `third-party/README.md` for the pinned toolchain.
Expand Down
41 changes: 41 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Gravity agent instructions

## Issue tracking

- Use GitHub Issues in this repository for all Gravity work, including internal
maintainer tasks, bugs, plans, and follow-ups. Do not create or update Linear
issues for Gravity. This overrides shared agent guidance that requires Linear
or `USE-XXX` identifiers.
- Use `gh issue list`, `gh issue view`, and `gh issue create` to find or track
work. Reuse a relevant issue instead of creating duplicates.
- Reference GitHub issue numbers (`#123`) in plans and pull requests. Use
`Fixes #123` only when merging the PR completes that issue.
- Keep credentials, private paths, account details, and private project data out
of public issues. Follow `SECURITY.md` for vulnerability reports. Do not copy
an old private backlog into public issues without reviewing it for disclosure
and confirming the migration scope.

## Workflow

- Read `CONTRIBUTING.md`. Outline a brief plan for non-trivial changes, then
implement authorized work without repeated permission requests.
- Use pnpm and run `pnpm run verify` before considering work complete. Report
any unavailable checks; use hosted visual CI if local Docker is unavailable.
- Preserve existing edits. Ask before deleting files, discarding changes,
rewriting history, force-pushing, or applying irreversible migrations.
- Never bypass hooks or branch protections. Release publication requires
authorization; a code or documentation change alone does not authorize it.

## Code and pull requests

- Keep changes concise and preserve strict TypeScript checks. No `any`,
unchecked type assertions, or non-null assertions. Narrow unknown inputs.
- Use static imports, braces for control flow, explicit return types for
exported functions, and readonly types where mutation is unnecessary.
- Prefer shared code over duplication.
- Use conventional commits with concise imperative subjects.
- Target `main`. PR descriptions must have **What**, **Why**, and **How tested**
sections, reference the relevant GitHub issue, and state rollout requirements
and validation limitations.
- Keep communication brief. Include `file_path:line_number` when referencing
code. Do not send announcements or third-party messages without authorization.
8 changes: 8 additions & 0 deletions CLAUDE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Gravity

Read and follow [AGENTS.md](AGENTS.md) for this repository's workflow and code
conventions. Gravity uses GitHub Issues for both contributor and internal work;
the repository instructions override shared guidance requiring Linear.

See [CONTRIBUTING.md](CONTRIBUTING.md) for setup and verification, and
[.claude/skills/README.md](.claude/skills/README.md) for optional agent workflows.
13 changes: 13 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,19 @@ expected and actual behavior. Remove tokens, personal paths, and private project
content from logs and screenshots. See [SECURITY.md](SECURITY.md) for security
reports.

## Issue tracking

GitHub Issues is the source of truth for all Gravity work, including internal
maintainer tasks and follow-ups. Use this repository's issues instead of Linear
or `USE-XXX` identifiers. Search for an existing issue before opening one, and
reference it as `#123` in discussions and pull requests. Use `Fixes #123` when a
PR fully resolves the issue.

The same workflow applies to coding agents; see [AGENTS.md](AGENTS.md). Review
private backlog items for sensitive information before proposing any migration
to public issues. Security reports belong in the private channel described in
[SECURITY.md](SECURITY.md).

## Development setup

Use a current stable Rust toolchain, Node.js 22, and pnpm 11. Building the native
Expand Down
Loading