-
-
Notifications
You must be signed in to change notification settings - Fork 0
docs: make AsciiDoc canonical for CONTRIBUTING/GOVERNANCE/MAINTAINERS #111
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+115
−230
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,20 +1,90 @@ | ||
| // SPDX-License-Identifier: CC-BY-SA-4.0 | ||
| // SPDX-FileCopyrightText: 2026 Jonathan D.A. Jewell | ||
| = Contributing Guide | ||
| :toc: preamble | ||
|
|
||
| Thank you for considering a contribution to Oblíbený. | ||
|
|
||
| == Getting Started | ||
|
|
||
| 1. Fork the repository | ||
| 2. Create a feature branch from `main` | ||
| 3. Sign off commits (`git commit -s`) | ||
| 4. Submit a pull request | ||
| [source,bash] | ||
| ---- | ||
| git clone https://github.com/hyperpolymath/oblibeny.git | ||
| cd oblibeny | ||
|
|
||
| == Commit Guidelines | ||
| just ci # dune lint + conformance suite + Zig FFI compile-check + escape-hatch guard | ||
| just proofs # type-check (= prove) the Idris2 ABI layer | ||
| ---- | ||
|
|
||
| * Conventional commits: `type(scope): description` | ||
| * Sign all commits (DCO required) | ||
| * Atomic, focused commits | ||
| Toolchain installation (OCaml 5.1.1 + dune, Idris2 0.7.0, Zig 0.13) is | ||
| documented in link:docs/TOOLCHAIN.adoc[docs/TOOLCHAIN.adoc]; the version | ||
| pins live in `.tool-versions`. | ||
|
|
||
| == License | ||
| == Repository Structure | ||
|
|
||
| ---- | ||
| oblibeny/ | ||
| ├── bin/ # OCaml executable entry point | ||
| ├── lib/ # OCaml compiler library (lexer, parser, typecheck, | ||
| │ # eval, constrained_check, static_analyzer) | ||
| ├── test/ # Conformance + unit suite (dune runtest) | ||
| ├── src/abi/ # Idris2 ABI proof layer (oblibeny-abi.ipkg; | ||
| │ # Packages/, Lang/ metatheory) | ||
| ├── ffi/zig/ # Zig crypto FFI (liboqs/libsodium) + obli-pkg | ||
| ├── examples/ # .obl programs and packages/hello.zpkg | ||
| ├── docs/ # Documentation (TOOLCHAIN, DISTRIBUTION-ARCHITECTURE, …) | ||
| ├── deploy/ # Deployment manifests (kubernetes/, svalinn-compose.yaml) | ||
| ├── .machine_readable/ # A2ML project metadata (6a2/) + contractiles | ||
| ├── .github/workflows/ # CI gates (see ci.yml root-cause note) | ||
| ├── justfile # Task runner — all operations go through this | ||
| ├── README.adoc | ||
| ├── GOVERNANCE.adoc # Sole-maintainer governance model | ||
| ├── MAINTAINERS.adoc | ||
| ├── ROADMAP.adoc | ||
| └── SECURITY.md | ||
| ---- | ||
|
|
||
| == How to Contribute | ||
|
|
||
| === Reporting Bugs | ||
|
|
||
| 1. Search existing issues first. | ||
| 2. Include environment details (OS, toolchain versions from `.tool-versions`), | ||
| steps to reproduce, and expected vs actual behaviour. | ||
|
|
||
| === Suggesting Features | ||
|
|
||
| Check link:ROADMAP.adoc[ROADMAP.adoc] and existing issues first, then open an | ||
| issue with a problem statement, proposed solution, and alternatives considered. | ||
|
|
||
| Contributions licensed under project license. | ||
| == Development Workflow | ||
|
|
||
| === Branch Naming | ||
|
|
||
| ---- | ||
| feat/short-description # New features | ||
| fix/issue-number-description # Bug fixes | ||
| docs/short-description # Documentation | ||
| test/what-added # Test additions | ||
| refactor/what-changed # Code improvements | ||
| security/what-fixed # Security fixes | ||
| ---- | ||
|
|
||
| === Commit Messages | ||
|
|
||
| We follow https://www.conventionalcommits.org/[Conventional Commits]: | ||
| `type(scope): description`. Sign off commits (`git commit -s`, DCO). | ||
| Keep commits atomic and focused. | ||
|
|
||
| === The Proof Gate | ||
|
|
||
| The Idris2 ABI layer is a *proof* layer: CI rejects any soundness escape | ||
| hatch (`believe_me`, `postulate`, `assert_total`, `partial`, `idris_crash`, | ||
| holes) in `src/abi/Crypto.idr` and `src/abi/Packages`. Run the same gate | ||
| locally with `just guard-escape-hatches`; `just ci` includes it. A change | ||
| that only passes by weakening a proof will not merge. | ||
|
|
||
| == License | ||
|
|
||
| Contributions are licensed under the project licence (see `LICENSE` and the | ||
| SPDX headers each file carries). | ||
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| // SPDX-License-Identifier: CC-BY-SA-4.0 | ||
| // SPDX-FileCopyrightText: 2026 Jonathan D.A. Jewell | ||
| = Learning Paths | ||
| :toc: preamble | ||
|
|
||
| Audience-divided paths for engaging with Oblíbený beyond setup and a basic | ||
| run. Skeleton for issue #79 — each track below becomes its own page. | ||
|
|
||
| == End users — _use the language_ | ||
|
|
||
| * The dual form: Turing-complete factory → Turing-incomplete constrained | ||
| form, and why. | ||
| * Writing and running `.obl`; the reversible/accountable constrained form; | ||
| the `echo[A,B]` residue by example. | ||
| * Reading the accountability trace (`--dump-trace`). | ||
| * `obli-pkg` usage and the triple-signature trust model | ||
| (Dilithium5 + SPHINCS+ + Ed25519). | ||
|
|
||
| == Developers — _extend the language_ | ||
|
|
||
| * Architecture walkthrough: | ||
| `lexer → parse → typecheck → eval → constrained_check → static_analyzer`. | ||
| * The proof layer for newcomers: the Idris2 ABI | ||
| (`installReversible`/`echoResidueNonTrivial`) and the `Lang.*` metatheory | ||
| (#78) — what each guarantee means, how to extend a slice, the | ||
| model-fidelity caveat. | ||
| * The Zig crypto FFI; adding a language feature end-to-end. | ||
|
|
||
| == Maintainers — _run the project_ | ||
|
|
||
| * CI gates (`justfile`, `ci.yml`), and the escape-hatch guard discipline. | ||
| * The contractiles + `.machine_readable/6a2/` governance model. | ||
| * The `docs/proof-debt.md` ledger discipline; standards reusable workflows; | ||
| the release transition. |
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.