docs: Add standards document for adoption of new SDKs
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 8.7k
- Forks
- 1.3k
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 253
Description
On the July 14, 2026 community call the issue of new SDK adoption came up. Presently we don't have any kind of standard for adopting new SDKs.
It would be good if we had a document which declared the standard that must be met before an SDK is adopted.
I think the standard should include:
- Local dev environment support. This may be obvious, but it means making sure
miseorNixorbazelor whichever tooling we use for specifying the environment incorporates support for the SDK's language - linting and unit testing of the SDK
- hooking that linting and unit testing into the automated testing mechanism (presently
mise) - Adding that to CI, probably as its own task/action
- Documenting the available features of the SDK. During development the SDK may not support everything, but even after release there may be some inherent limitations of the SDK, or new features of OpenShell not yet supported by it, so those should be documented. I have in mind how Gateway API does it.
It would be extremely valuable if we had a conformance testing environment that we could run SDK tests against; a predefined set of actions that the SDK will exercise to show it conforms to some level of OpenShell support. We don't have that yet, but if we did have that, the standard would include running that conformance test.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the current mise-based development setup and automated testing or CI workflow to understand how SDK support is integrated today. Draft a standards document covering environment support, linting, unit tests, CI tasks, SDK feature limitations, and the future conformance-testing requirement; done means the adoption criteria are explicit and actionable.
Written by the indexing model from the issue text.
Assessment
- Domain
- ci-cd, devops, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100