Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
143 lines (108 loc) · 5.73 KB

CONTRIBUTING.md

File metadata and controls

143 lines (108 loc) · 5.73 KB

Contributing to arcp

Thanks for your interest in improving the Ruby SDK for ARCP. This document covers how to report issues, propose changes, and get a change merged.

By participating you agree to the Code of Conduct.

Where changes belong

ARCP is two things in two places, and a change belongs to exactly one of them:

  • The protocol — the wire format, message semantics, lease rules, error taxonomy, feature flags. These live in the specification repository. If your idea changes what goes on the wire or what a conformant runtime must do, it is a spec change — open it there, not here. This SDK implements the spec; it does not define it.
  • This SDK — how the protocol is expressed idiomatically in Ruby: bugs, ergonomics, performance, missing-but-specified features, docs, tests. Those belong here.

When in doubt, open an issue here and we'll redirect if it's really a protocol question.

The golden rule: conform, don't extend

A change to this SDK must keep it a faithful client of ARCP v1.1 (draft). Concretely:

  • Don't invent wire behavior. No envelope fields, event kinds, error codes, or feature flags that the spec doesn't define. If you need one, it's a spec proposal first.
  • Negotiate honestly. Only advertise a feature flag in session.hello once the SDK actually implements it. The feature matrix in the README must match what the code negotiates — a row marked Supported is a promise.
  • Respect the semantics. Sequence numbers stay gap-free and monotonic; LEASE_EXPIRED and BUDGET_EXHAUSTED stay non-retryable; the effective feature set is the intersection of client and runtime advertisements. Tests must not paper over a semantic the spec requires.
  • Stay layered. This SDK controls runtimes. It does not expose tools (that's MCP) or export telemetry (that's OpenTelemetry). PRs that blur those layers will be asked to move the logic out.

Reporting bugs

Open an issue with: the SDK version and Ruby version, the runtime you connected to, a minimal reproduction (the smallest program that triggers it), what you expected, and what happened. A failing test is the best possible bug report. Wire-level traces (the envelopes exchanged) help enormously for protocol behavior — redact any auth.token or provisioned-credential value first.

Proposing a change

For anything beyond a small fix, open an issue describing the problem before writing code, so we can agree on the approach. Small, focused PRs review faster than large ones; if a change is big, say so early and we'll help break it down.

Development setup

This gem targets Ruby 3.4+ (see .ruby-version) and uses Bundler to manage dependencies. Clone the repo and install everything declared in the Gemfile and arcp.gemspec:

git clone https://github.com/nficano/arpc.git
cd arpc/ruby-sdk
bundle install

The default Rake task runs both specs and RuboCop, which is the fastest way to confirm a working checkout:

bundle exec rake

Tests and conformance

Two layers must pass before a PR merges:

  • Unit tests — this SDK's own suite:

    bundle exec rake spec

  • Conformance — the SDK's behavior against the reference runtime. New protocol-facing code (session negotiation, event sequencing, lease handling, error mapping) needs a test that exercises the real exchange, not a mock that assumes the answer. The conformance suite lives under spec/conformance/ and runs end-to-end against the in-process reference runtime via Arcp::Transport::MemoryTransport.pair; invoke it with bundle exec rake conformance. To point the suite at an out-of-process runtime instead, set the ARCP_RUNTIME_URL environment variable to a reachable WebSocket endpoint before running the task.

CI runs both on every PR. A PR that changes which feature flags the SDK negotiates must also update the README feature matrix in the same change.

Coding standards

This repo enforces formatting and lint with RuboCop (plus the rubocop-performance, rubocop-rake, and rubocop-rspec plugins) and uses Steep with RBS signatures under sig/ for type checking. YARD docstrings are required on public API; bundle exec rake docs rebuilds the reference under docs/api/.

bundle exec rubocop          # lint and format
bundle exec steep check      # type-check against sig/
bundle exec yard --fail-on-warning  # validate doc comments

Match the surrounding code. Public API changes need doc comments and an entry in the changelog. Prefer clarity over cleverness in a library others build on.

Commit and pull-request conventions

  • Write focused commits with present-tense, imperative subjects (add result_chunk reassembly, not added / adds).

  • Reference the issue a PR closes (Closes #123).

  • Keep the PR description honest about scope and any spec sections touched.

  • Rebase on the default branch and ensure CI is green before requesting review.

  • Sign off your commits to certify the Developer Certificate of Origin:

    git commit -s -m "your message"

Releases

Releases are cut by maintainers. The gem is published to RubyGems.org; pushing a v* tag triggers the publish GitHub Actions workflow, which builds arcp.gemspec and runs gem push. The SDK is versioned with semantic versioning independently of the protocol version it speaks; a protocol version bump is noted in the changelog when the negotiated ARCP version changes.

License

By contributing, you agree that your contributions are licensed under the project's Apache-2.0 license.