Skip to content

OSAC-4006: Fold protobuf-conventions into AGENTS.md, fix broken buf-lint hooks, sync cli-ux #322

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tchughesiv merged 5 commits into from
Aug 14, 2026
Merged

OSAC-4006: Fold protobuf-conventions into AGENTS.md, fix broken buf-lint hooks, sync cli-ux #322

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e064bfa
OSAC-4006: Relocate protobuf-conventions rule to fulfillment-service …
tchughesiv Aug 13, 2026
dd93a7c
OSAC-4006: fold protobuf-conventions.md into AGENTS.md, add cli-ux.md…
tchughesiv Aug 13, 2026
ce86bf1
OSAC-4006: fix broken bare buf-lint hooks in fulfillment-service sett…
tchughesiv Aug 13, 2026
e53879b
OSAC-4006: fix over-escaped quoting in fulfillment-service settings.j…
tchughesiv Aug 13, 2026
b797c1b
OSAC-4006: Fix stale bare buf lint references in AGENTS.md
tchughesiv Aug 13, 2026
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
11 changes: 11 additions & 0 deletions fulfillment-service/.claude/rules/protobuf-conventions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Protocol Buffer Conventions

See [AGENTS.md § API Design Guidelines](../../AGENTS.md#api-design-guidelines) before adding or modifying any `.proto` file — [`docs/API.md`](../../docs/API.md) is the authoritative source for all API conventions (object structure, naming, services, request/response patterns, REST transcoding, enums, conditions, references, and documentation requirements).

OSAC follows [Kubernetes API conventions](https://github.com/kubernetes/community/blob/main/contributors/devel/sig-architecture/api-conventions.md) adapted for protobuf.

## Workflow

- Always run `buf lint` before committing proto changes
Comment thread
coderabbitai[bot] marked this conversation as resolved.
Resolved
- Regenerate code by running `buf generate` after proto changes
- `SERVICE_SUFFIX` lint rule is intentionally excluded in `buf.yaml`
4 changes: 2 additions & 2 deletions fulfillment-service/internal/cmd/cli/.claude/rules/cli-ux.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# CLI UX Guidelines

The OSAC CLI is a tenant-facing tool for managing infrastructure resources. It is NOT a Kubernetes admin tool - end users should not need to know k8s.
The OSAC CLI (`internal/cmd/cli/`) is a tenant-facing tool for managing infrastructure resources. It is NOT a Kubernetes admin tool - end users should not need to know k8s.

## Design Inspiration

Expand All @@ -10,7 +10,7 @@ The OSAC CLI is a tenant-facing tool for managing infrastructure resources. It i

## Existing Verbs

`create`, `get`, `describe`, `edit`, `delete`, `annotate`, `label`, `login`, `logout`, `lookup`, `console`, `whoami`, `version`
`create`, `get`, `describe`, `edit`, `delete`, `annotate`, `label`, `login`, `logout`, `console`, `scale`, `tenant`, `whoami`, `version`

## When Adding New CLI Commands

Expand Down
Loading