Skip to content

Contrib onramp: CODEOWNERS and Adding-an-example guide#1

Merged
Faux16 merged 1 commit into
mainfrom
contrib-onramp
May 26, 2026
Merged

Contrib onramp: CODEOWNERS and Adding-an-example guide#1
Faux16 merged 1 commit into
mainfrom
contrib-onramp

Conversation

@Faux16

@Faux16 Faux16 commented May 26, 2026

Copy link
Copy Markdown
Contributor

What this changes

  • `.github/CODEOWNERS` — route examples PRs to maintainers.
  • `README.md` — add an Adding an example section that walks new contributors through the conventions:
    1. Pick a slot from the "coming" rows in the table or propose a new one.
    2. Self-contained `Makefile` with a `demo` target + short README.
    3. Sign every artifact with the SDK (no hand-rolled crypto).
    4. Add a smoke test under `tests/` that fails if the demo's output stops matching expectations.
    5. State which conformance level (L1 / L2 / L3) the example exercises.

Plus a Contributing pointer to org-level docs.

Type of change

  • Documentation only

Cross-language impact

  • No impact

Checklist

  • Commits are DCO-signed
  • One logical change per PR
  • Docs updated

Part of the Phase 2 contributor-friendliness pass.

- .github/CODEOWNERS — route examples PRs to maintainers.
- README: add an "Adding an example" section that walks new
  contributors through the conventions (self-contained Makefile,
  use the SDK for crypto, smoke test under tests/, state the
  conformance level exercised), and a Contributing pointer to the
  org docs.

Phase 2 of the contributor-friendliness pass.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Signed-off-by: SANKET SARKAR <sanketsarkar70@gmail.com>
@Faux16 Faux16 merged commit a273383 into main May 26, 2026
3 checks passed
@Faux16 Faux16 deleted the contrib-onramp branch May 26, 2026 14:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant