Skip to content

docs: tooling API style guide#1926

Merged
chris-de-leon-cll merged 4 commits intomainfrom
docs/tooling-api-style-guide
Apr 6, 2026
Merged

docs: tooling API style guide#1926
chris-de-leon-cll merged 4 commits intomainfrom
docs/tooling-api-style-guide

Conversation

@chris-de-leon-cll
Copy link
Copy Markdown
Collaborator

@chris-de-leon-cll chris-de-leon-cll commented Apr 2, 2026

Add Tooling API Style Guide

Summary

This PR adds a Changeset Style Guide under deployment/docs/. The document captures recurring review feedback as explicit rules, short rationale, and before/after Go examples. It is meant to improve new changesets and code you are already editing, not to force broad rewrites of legacy code that is already correct and safe to operate.

What’s in the guide

The guide covers practical topics that show up often in deployment changeset review. The techniques in the guide will allow you to write changests that are:

  • Safe to retry
  • Easy to operate
  • Hard to misconfigure
  • Consistent with repo conventions
  • Explicit about failure modes
  • Minimal in abstraction and validation

How reviewers and authors can use it

  • While authoring: apply the rules to inputs, defaults, ref resolution, and apply behavior early.
  • Before review: run the checklist to catch retry hazards, stale reads, inconsistent conventions, and unnecessary abstraction.

Notes

  • When a recommendation conflicts with established conventions in a file, the guide recommends preferring local consistency unless there is a clear correctness, safety, or operability reason not to.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a new Changeset Style Guide document to capture recurring review feedback as explicit rules, rationale, and before/after examples to improve the safety and operability of deployment changesets.

Changes:

  • Introduces a “Changeset Style Guide” under deployment/docs/ with practical rules (idempotency, ref resolution, defaults, cached reads, qualifiers, validation).
  • Provides a review checklist to standardize pre-review self-checks.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread deployment/docs/style-guide.md
Comment thread deployment/docs/style-guide.md
Comment thread deployment/docs/style-guide.md
Comment thread deployment/docs/style-guide.md
Comment thread deployment/docs/style-guide.md Outdated
Comment thread deployment/docs/style-guide.md
Comment thread deployment/docs/style-guide.md
Comment thread deployment/docs/style-guide.md
@tt-cll tt-cll marked this pull request as ready for review April 6, 2026 11:14
@tt-cll tt-cll requested review from a team as code owners April 6, 2026 11:14
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 6, 2026

Metric docs/tooling-api-style-guide main
Coverage 70.1% 69.8%

@chris-de-leon-cll chris-de-leon-cll added this pull request to the merge queue Apr 6, 2026
Merged via the queue into main with commit f3ec396 Apr 6, 2026
57 checks passed
@chris-de-leon-cll chris-de-leon-cll deleted the docs/tooling-api-style-guide branch April 6, 2026 20:42
return nil
}

// ✅ BETTER: deploy and persist only when the ref does not already exist
Copy link
Copy Markdown
Contributor

@RayXpub RayXpub Apr 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

q: isn't this already handled at the operations level by the operations API though?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants