Skip to content

docs(rfc): add RFC 0014 SDK acceptance scorecard - #2293

Closed
rhuss wants to merge 1 commit into
NVIDIA:mainfrom
rhuss:rfc/sdk-acceptance-scorecard
Closed

docs(rfc): add RFC 0014 SDK acceptance scorecard#2293
rhuss wants to merge 1 commit into
NVIDIA:mainfrom
rhuss:rfc/sdk-acceptance-scorecard

Conversation

@rhuss

@rhuss rhuss commented Jul 15, 2026

Copy link
Copy Markdown
Contributor

Summary

Propose a tiered conformance framework for OpenShell language SDKs. The RFC defines three API conformance tiers (Core, Extended, Full), three auth levels (L1 static, L2 token lifecycle, L3 OIDC), operational requirements (linting, testing, proto sync, CI), and a standard scorecard format.

The primary deliverable is a scorecard document that serves as the living acceptance contract for current and future language SDKs.

Motivation

The Go SDK contribution (#2044, tracked in #2270) is the first new language SDK and surfaced the lack of formal acceptance criteria. This was discussed in the contributor meeting on 2026-07-14. The RFC establishes a shared framework so contributors know what to target and reviewers have a concrete checklist.

What's in this RFC

  • 3 API tiers: Core (sandbox, exec, file, health), Extended (providers, config, policy, services), Full (SSH, TCP, edge, interactive exec)
  • 3 auth levels: L1 (static token), L2 (token refresh, custom auth providers), L3 (OIDC discovery, device-code, auth-code flows)
  • Operational requirements: linting, testing, proto sync freshness checks, CI job structure
  • Scorecard format: standard conformance matrix for each SDK's README

Note: the RFC number 0014 is tentative pending maintainer assignment from issue #2292.

Related

Propose a tiered conformance framework for OpenShell language SDKs
with three API tiers (Core, Extended, Full), three auth levels
(L1 static, L2 token lifecycle, L3 OIDC), operational requirements
(linting, testing, proto sync, CI), and a standard scorecard format.

The RFC number is tentative pending maintainer assignment.

Signed-off-by: Roland Huß <rhuss@redhat.com>
@rhuss
rhuss requested review from a team, derekwaynecarr, maxamillion and mrunalp as code owners July 15, 2026 08:18
@copy-pr-bot

copy-pr-bot Bot commented Jul 15, 2026

Copy link
Copy Markdown

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@krishicks

Copy link
Copy Markdown
Collaborator

Relates to #2267

@rhuss

rhuss commented Jul 30, 2026

Copy link
Copy Markdown
Contributor Author

Let's park that RFC and learn from onboarding the Typescript and Golang SDK, before we prematurely introduce some guardrails here.

@rhuss rhuss closed this Jul 30, 2026
@github-project-automation github-project-automation Bot moved this from Todo to Done in OpenShell Roadmap Jul 30, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants