From 374c64186f351e6a11b08c0bf1d21edc6d004c6d Mon Sep 17 00:00:00 2001 From: SANKET SARKAR Date: Tue, 26 May 2026 19:28:10 +0530 Subject: [PATCH] docs(contrib): CODEOWNERS and an "Adding an example" section MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - .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) Signed-off-by: SANKET SARKAR --- .github/CODEOWNERS | 3 +++ README.md | 14 ++++++++++++++ 2 files changed, 17 insertions(+) create mode 100644 .github/CODEOWNERS diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..72f66db --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,3 @@ +# See https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners + +* @fuax16 diff --git a/README.md b/README.md index ee7a603..8be0547 100644 --- a/README.md +++ b/README.md @@ -38,6 +38,20 @@ pytest tests/ Examples have CI smoke tests that fail when the SDK or spec drift in a way that breaks the demo. +## Adding an example + +New examples are welcome — they're often the clearest way for a new contributor to learn the protocol. + +1. Pick a slot from the "*coming*" rows in the table above, or propose a new one via a [Feature request](https://github.com/openagp/examples/issues/new?template=feature_request.yml). +2. Make it self-contained: a `Makefile` with a `demo` target and a short README explaining the scenario. +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. Document which conformance level (L1 / L2 / L3) the example exercises. + +## Contributing + +See [CONTRIBUTING.md](https://github.com/openagp/.github/blob/main/CONTRIBUTING.md) at the org level for DCO sign-off and PR conventions, and [SUPPORT.md](https://github.com/openagp/.github/blob/main/SUPPORT.md) for where to ask questions or file bugs. + ## License [Apache-2.0](LICENSE).