docs: redrafted README for improved developer onboarding#18
Draft
paulinebanye wants to merge 2 commits into
Draft
docs: redrafted README for improved developer onboarding#18paulinebanye wants to merge 2 commits into
paulinebanye wants to merge 2 commits into
Conversation
paulinebanye
marked this pull request as draft
July 21, 2026 06:45
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this PR do?
This PR updates
README.mdto provide clearer onboarding and contribution guidance for developers working withori-sdk-python.The documentation now explains how to clone the repository, create and push a new branch, install the SDK and development dependencies, use the main SDK features, run the existing quality checks, and contribute changes.
The goal is to make the repository easier for new contributors to set up and understand without changing SDK behaviour or contracts.
Type of change
feat- new SDK API, model, client, or helperfix- bug fix or contract correctiondocs- documentation onlytest- tests onlyrefactor- no behavior changesecurity- touches signing, validation, install safety, or trust boundariescontract-change- changes a cross-repo contract mirrored from ori-specs/runtimeRequired checklist
pytest -qpassesmypy ori_sdk testspassesruff check ori_sdk testspassesruff format --check ori_sdk testspasses.pyfile has the Apache-2.0 license headerori_sdk/__init__.pyare updated if a public API was addedContract and compatibility checklist
ori-specsor runtime behavior; it does not redefine runtime authoritySecurity-sensitive checklist
Complete if this PR touches signing, Hub install, tarball extraction, or skill validation.
cryptography, not PyNaCl, where runtime interoperability mattersIf you used AI assistance
Related issue
Closes #17
Testing notes
The following checks were run:
This is a documentation-only change. No SDK behaviour, public APIs, fixtures, or contracts were modified.