Skip to content
ContractSpec
Start here

Core guide · Operations · 3 min read

Contribute a reviewable change

Change the owning source, update the public explanation and bring evidence for the behavior you touched.

Source context

Source-guided · d58fa5b7

Repository links may require access. Source inspection is separate from a clean public-package installation.

AN INTERACTIVE READING MAP

Get the shape of this guide.

Move through the ideas, inspect their relationships, or make a focused reading path. The complete guide stays below.

READING SEQUENCE

Understand how the ideas connect

01 / READING POINT

Read the instructions for the selected checkout

Begin with the repository's AGENTS.md and the instructions in the owning package. The integration branch is actively changing, so locate the current owner rather than relying on a historical directory map.

Keep the problem statement small: the incorrect behavior, why it matters, the intended change and the compatibility impact. A focused issue or pull request is easier to review than a large cleanup tied to an unrelated feature.

1 / 4

0 points in your packet

Read the instructions for the selected checkout

Begin with the repository's AGENTS.md and the instructions in the owning package. The integration branch is actively changing, so locate the current owner rather than relying on a historical directory map.

Keep the problem statement small: the incorrect behavior, why it matters, the intended change and the compatibility impact. A focused issue or pull request is easier to review than a large cleanup tied to an unrelated feature.

Change the owning source

Application routes are thin wrappers; reusable docs and marketing bodies live in their bundles. Portable contract declarations, runtime execution and provider integrations have different owners. Respect those boundaries when choosing where a fix belongs.

For generated docs or agent configuration, update the canonical input and use the existing generator. Hand-editing a generated file can hide the problem until the next regeneration.

ChangeLikely owning sourceAccompanying update
Learning articleLibrary docs content and manifestNavigation, related links and metadata
Contract declarationCanonical model or domain packageReference docs and compatibility examples
Runtime behaviorOwning runtime or adapterFocused behavior and failure tests
Published package changeOwning packageRelease notes/capsule through the current workflow

Bring the evidence that matters

Run the narrow checks required by the checkout for the changed area. Include a meaningful failing case when behavior is fixed. If a change affects a public package boundary, distinguish source tests from emitted declarations and an isolated consumer.

Report commands actually run and any blocked checks. Do not describe a source reading, a stubbed provider or a metadata smoke test as a production qualification.

Explain the result to the next maintainer

A useful change description leads with the problem, then explains the new behavior and its validation. Mention intentional compatibility changes and the migration path. Keep unrelated reformatting and architectural moves out of the same review.

The repository's contribution guidance calls for paired changeset and release-capsule records for published-package release work. Follow the current release workflow in the chosen checkout rather than copying old command sequences from a different branch.

Make the contribution easy to evaluate.

A focused change becomes more useful when the next person can reproduce the question it answers.

What are you improving?

A CONCRETE SITUATION

Connect the correction to its evidence.

A guide describes an input, command or execution guarantee inaccurately.

What changes

Update the explanation and the examples that depend on it.

What stays explicit

A source-only capability should not become a public installation claim through wording.

Follow the consequence

Link the exact source or executed example that supports the correction, with the same release context in human and agent guidance.

An authored situation, grounded in the linked source guides. Choosing a case explores its expected responsibilities; it does not execute an operation.