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
4 changes: 4 additions & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Default owners — auto-requested for review on every PR.
# When a second maintainer joins, also enable "Require review from Code Owners"
# and set required approving reviews to 1 (Settings → Branches → main).
* @tvinz
26 changes: 26 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Contributing to usagemeter

Thanks for helping out! A few conventions.

## Dev setup
- Install [Bun](https://bun.sh), then `bun install`.
- `bun run once` — prints your current usage (needs a logged-in Claude Code).
- `bun start` — runs the backend (dashboard at http://localhost:7777). The GNOME panel UI
is the extension under `gnome-extension/` (see the README → Install section).

## Workflow (`main` is protected)
- Branch off `main`, push, and open a PR.
- CI (`check`) must pass: it runs `bun build` plus shell and extension syntax checks.
- Merges are **squash-only**; the source branch is auto-deleted after merge.
- Direct pushes to `main` are reserved for maintainers — please use a PR otherwise.

## Touching the GNOME extension
GNOME caches extension code, so after changing anything under `gnome-extension/`, **reload
the Shell (log out/in)** to test. Don't run `gnome-shell --replace` on a VM/remote display —
it can crash the session.

## Maintainers — scaling to a team
Solo today, so branch protection requires a PR + green CI but **0 approvals** (so you can
self-merge). **When a second maintainer joins:** set *Required approving reviews* to **1**
and turn on *Require review from Code Owners* — the mechanism is already in place, it's just
one toggle.