|
1 | | -# verifrax/.github |
| 1 | +# Verifrax .github |
2 | 2 |
|
3 | | -## Purpose |
| 3 | +Canonical organization governance and default-community surface for Verifrax repositories. |
4 | 4 |
|
5 | | -Organization-wide GitHub defaults (.github) for Verifrax repositories. |
| 5 | +This repository is not the protocol, not the authority layer, and not the execution layer. |
| 6 | +It defines the shared GitHub-level organizational surface used across the Verifrax repository perimeter. |
6 | 7 |
|
7 | | -## Status |
| 8 | +## Role |
8 | 9 |
|
9 | | -- **Stability**: Experimental |
10 | | -- **SemVer**: Not guaranteed until v1.0.0 |
11 | | -- **Security**: See **Security** section below |
| 10 | +This repository exists to provide the organization-wide defaults and governed registry surfaces that apply across Verifrax repositories. |
12 | 11 |
|
13 | | -## Scope |
| 12 | +It is the control surface for: |
14 | 13 |
|
15 | | -- What this repo is responsible for |
16 | | -- What it explicitly does **not** do |
| 14 | +- shared GitHub governance defaults |
| 15 | +- organization profile presentation |
| 16 | +- issue and pull request defaults |
| 17 | +- repository perimeter registration |
| 18 | +- workflow and policy surfaces that must apply at organization scope |
17 | 19 |
|
18 | | -## Quickstart |
| 20 | +## What this repository is |
19 | 21 |
|
20 | | -```bash |
21 | | -# clone |
22 | | -git clone https://github.com/Verifrax/verifrax/.github.git |
23 | | -cd verifrax/.github |
| 22 | +This repository is the canonical GitHub organization surface for Verifrax. |
24 | 23 |
|
25 | | -# install (adjust if needed) |
26 | | -# (placeholder) npm install / pnpm install / go test ./... / etc. |
27 | | -``` |
| 24 | +It is responsible for: |
28 | 25 |
|
29 | | -## Repository layout |
| 26 | +- `.github/profile/README.md` organization profile content |
| 27 | +- shared contribution and conduct defaults |
| 28 | +- security reporting guidance at organization scope |
| 29 | +- governed and non-governed repository registry surfaces |
| 30 | +- organization-wide workflow defaults where explicitly intended |
30 | 31 |
|
31 | | -- `/` Root sources |
32 | | -- `/.github/` Issue + PR templates |
33 | | -- `/docs/` Documentation (if present) |
| 32 | +## What this repository is not |
| 33 | + |
| 34 | +This repository is not: |
| 35 | + |
| 36 | +- the VERIFRAX protocol repository |
| 37 | +- the AUCTORISEAL authority repository |
| 38 | +- the CORPIFORM execution repository |
| 39 | +- a package distribution surface |
| 40 | +- a placeholder demo repository |
| 41 | + |
| 42 | +It must not describe speculative install flows, placeholder quickstarts, or generic template language that is not materially true. |
| 43 | + |
| 44 | +## Canonical public repositories |
| 45 | + |
| 46 | +Start with these public surfaces: |
| 47 | + |
| 48 | +- **[VERIFRAX](https://github.com/Verifrax/VERIFRAX)** — canonical protocol, evidence index, and verification boundary |
| 49 | +- **[AUCTORISEAL](https://github.com/Verifrax/AUCTORISEAL)** — authority sealing and issuance boundary |
| 50 | +- **[CORPIFORM](https://github.com/Verifrax/CORPIFORM)** — authority-governed execution and receipt boundary |
| 51 | + |
| 52 | +## Organization profile surface |
| 53 | + |
| 54 | +The public organization front page is defined here: |
| 55 | + |
| 56 | +- `profile/README.md` |
| 57 | + |
| 58 | +That file must stay aligned with the actual current public boundary of the stack. |
34 | 59 |
|
35 | 60 | ## Security |
36 | 61 |
|
37 | | -- Report vulnerabilities privately: **security@verifrax.org** |
38 | | -- Do **not** open public issues for sensitive findings |
| 62 | +Report sensitive security issues privately through GitHub Security Advisories when available. |
| 63 | + |
| 64 | +If repository-specific security guidance exists, follow that repository’s `SECURITY.md`. |
| 65 | + |
| 66 | +Do not publish sensitive vulnerabilities in public issues. |
| 67 | + |
| 68 | +## Contribution boundary |
| 69 | + |
| 70 | +Changes in this repository affect organization-wide presentation or governance defaults. |
| 71 | + |
| 72 | +Contributions here must therefore remain: |
39 | 73 |
|
40 | | -## Contributing |
| 74 | +- materially true |
| 75 | +- non-placeholder |
| 76 | +- organization-scoped |
| 77 | +- aligned with active Verifrax repository reality |
41 | 78 |
|
42 | | -See `CONTRIBUTING.md`. |
| 79 | +## Design rule |
43 | 80 |
|
44 | | -## License |
| 81 | +No placeholder text. |
| 82 | +No fake install instructions. |
| 83 | +No stale organizational claims. |
45 | 84 |
|
46 | | -MIT. See `LICENSE`. |
| 85 | +This repository must remain a truthful GitHub organization surface only. |
0 commit comments