|
| 1 | +# CLAUDE.md |
| 2 | + |
| 3 | +## Project purpose |
| 4 | +Registry of signed VyOS Contributor License Agreements (CLAs). The `README.md` is the canonical CLA text; `signatures/` holds a record per signer. Hosts the reusable `cla-check.yml` workflow that gates contributions to all VyOS repositories. |
| 5 | + |
| 6 | +## Tech stack |
| 7 | +- Plain text + Markdown. No build system. |
| 8 | +- `.github/workflows/cla-reusable.yml` — the reusable workflow consumed by every other VyOS repo's `cla-check.yml`. |
| 9 | + |
| 10 | +## Build / test / run |
| 11 | +N/A — additions land via PR. The CLA workflow inspects PR authors against `signatures/` and blocks merges when a signature is missing. |
| 12 | + |
| 13 | +## Repository layout |
| 14 | +- `README.md` — CLA text (the legal agreement). |
| 15 | +- `signatures/version1/` — one file per signer (current schema). |
| 16 | +- `.github/workflows/cla-reusable.yml` — the reusable CLA-check workflow. |
| 17 | + |
| 18 | +## Cross-repo context |
| 19 | +**Canonical CLA gate.** Every VyOS-org and VyOS-Networks-org repo's `cla-check.yml` ultimately delegates to: |
| 20 | +``` |
| 21 | +uses: vyos/vyos-cla-signatures/.github/workflows/cla-reusable.yml@current |
| 22 | +``` |
| 23 | +This is the only path by which a contributor's signature is validated. The workflow is also referenced indirectly through `vyos/.github`'s `cla-check.yml` reusable. |
| 24 | + |
| 25 | +## Conventions |
| 26 | +- Commit/PR title: `component: T12345: description` (Phorge task ID at https://vyos.dev) where applicable. New-signature PRs typically reference the signing workflow rather than a feature task. |
| 27 | +- Reusable workflow pin: floating `@current` — changes propagate immediately to every consumer. |
| 28 | +- Public repo: contains real names/emails of signers. Do not redact existing entries; only append. |
| 29 | + |
| 30 | +## Mirror relationship |
| 31 | +No mirror twin. Canonical repo on the `vyos/*` side only. |
| 32 | + |
| 33 | +## Notes for future contributors |
| 34 | +- **Do not modify the CLA text in `README.md`** without legal review — it's a binding agreement between contributors and VyOS Networks. |
| 35 | +- New signatures are merged by maintainers, not by the contributor. The workflow auto-detects who has signed. |
| 36 | +- Schema is `signatures/version1/`; if a `version2/` is ever introduced, update the reusable workflow to scan both directories during the transition. |
| 37 | +- This repo is referenced by floating `@current` from every consumer — any breaking workflow-input change is an org-wide outage. |
| 38 | + |
| 39 | +--- |
| 40 | + |
| 41 | +This file is mirrored on Confluence: [`vyos/vyos-cla-signatures`](https://internal.confluence.vyos.com/wiki/spaces/VYOS/pages/818184670). The Confluence page also carries the per-repo audit data (settings, workflows, secret counts, hygiene) that complements this CLAUDE.md. Edit either side; resync via the documentation pipeline. |
0 commit comments