docs: add CONTRIBUTING.md (bounty + platform guide) and README table of contents - #95
Open
EslaM-X wants to merge 1 commit into
Open
docs: add CONTRIBUTING.md (bounty + platform guide) and README table of contents#95EslaM-X wants to merge 1 commit into
EslaM-X wants to merge 1 commit into
Conversation
…of contents The repo grew a registry, scripts, validators, and CI — but the front door (README) still described only tunnel/ and bridge/, and there was no contributing guide at all. New contributors had to reverse-engineer the submission shape from other PRs. - CONTRIBUTING.md: end-to-end guide for both contribution tracks — robot profile (bounty) submissions with the registry layout, naming rules, the Zenoh action contract, the honesty rule for validation-report.md, and a submission checklist — plus platform conventions (Go/Python/CI) and the reviewer checklist. - README.md: table of contents, updated repository layout (registry/, scripts/, docs/, pyproject.toml), and a Contributing section pointing at the new guide. Pure docs — no code or workflow changes.
11 tasks
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
1 participant
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.
Summary
Pure documentation — the repo grew a
registry/, validators, and CI, but the README still described onlytunnel/andbridge/, and there was no contributing guide at all. New contributors had to reverse-engineer the submission shape from other PRs.This PR is the front door and the playbook:
CONTRIBUTING.md— both contribution tracks, end to endregistry/vendors/<vendor>/<robot>/<profile>.v1/layout, file catalogue, naming rules (profileId== directory name, uniqueness), the Zenoh action contract (robot/tunnel/actionenvelope), the honesty rule fordocs/validation-report.md, and a submission checklist.gofmt,golangci-lint, table-driven tests), Python (ruff,pytest, pure-logic scope), and CI conventions (SHA-pinned actions,timeout-minutes, least-privilegepermissions,concurrency).README.md— table of contents + updated realityregistry/,scripts/,docs/,pyproject.toml.CONTRIBUTING.md.Notes
docs/registry.mdvalidator guide) and ci+test: Python quality baseline for the shared bridge (ruff + pytest), fix ActionEvent parser crash #94 (Python quality baseline) — this PR is the entry point, those are the enforcement.— EslaM-X 🇪🇬