diff --git a/ARCHITECTURE.adoc b/ARCHITECTURE.adoc new file mode 100644 index 0000000..1c0a7a6 --- /dev/null +++ b/ARCHITECTURE.adoc @@ -0,0 +1,48 @@ +== Architecture + +=== Overview + +This repository follows a modular, maintainable architecture designed +for clarity, scalability, and long-term sustainability. + +=== Directory Structure + +.... +. +├── src/ # Source code +├── tests/ # Test suites +├── docs/ # Documentation +├── scripts/ # Utility scripts +├── config/ # Configuration files +├── LICENSE # License file +├── LICENSES/ # Full license texts +└── README.adoc # Project documentation +.... + +=== Design Principles + +* *Separation of Concerns*: Each module has a single responsibility +* *Testability*: Code is written to be easily testable +* *Documentation*: All public APIs are documented +* *Configuration*: Environment-specific settings are externalized + +=== Dependencies + +* External dependencies are minimized and clearly declared +* Version pinning is used for reproducibility + +=== Security Considerations + +* Sensitive data is never committed to the repository +* Secrets are managed through environment variables or secure vaults +* Regular dependency audits are performed + +=== Maintainability + +* Code follows consistent style guidelines +* Pull requests require review and CI checks +* Issues and discussions are tracked transparently + +''''' + +_Last updated: 2026-07-18_ diff --git a/ARCHITECTURE.md b/ARCHITECTURE.md deleted file mode 100644 index 607e3d8..0000000 --- a/ARCHITECTURE.md +++ /dev/null @@ -1,47 +0,0 @@ -# Architecture - -## Overview - -This repository follows a modular, maintainable architecture designed for clarity, scalability, and long-term sustainability. - -## Directory Structure - -``` -. -├── src/ # Source code -├── tests/ # Test suites -├── docs/ # Documentation -├── scripts/ # Utility scripts -├── config/ # Configuration files -├── LICENSE # License file -├── LICENSES/ # Full license texts -└── README.adoc # Project documentation -``` - -## Design Principles - -- **Separation of Concerns**: Each module has a single responsibility -- **Testability**: Code is written to be easily testable -- **Documentation**: All public APIs are documented -- **Configuration**: Environment-specific settings are externalized - -## Dependencies - -- External dependencies are minimized and clearly declared -- Version pinning is used for reproducibility - -## Security Considerations - -- Sensitive data is never committed to the repository -- Secrets are managed through environment variables or secure vaults -- Regular dependency audits are performed - -## Maintainability - -- Code follows consistent style guidelines -- Pull requests require review and CI checks -- Issues and discussions are tracked transparently - ---- - -*Last updated: 2026-07-18* diff --git a/CHANGELOG.adoc b/CHANGELOG.adoc new file mode 100644 index 0000000..3b2b735 --- /dev/null +++ b/CHANGELOG.adoc @@ -0,0 +1,203 @@ +== Changelog + +All notable changes to `+palimpsest-plasma+` will be documented in this +file. + +This file is generated from conventional commits by the +https://github.com/hyperpolymath/standards/blob/main/.github/workflows/changelog-reusable.yml[`+changelog-reusable.yml+`] +workflow (`+hyperpolymath/standards#206+`). Adopt the workflow in this +repo’s CI to keep this file in sync automatically — see +https://github.com/hyperpolymath/standards/blob/main/templates/cliff.toml[`+templates/cliff.toml+`] +for the canonical config. + +The format follows https://keepachangelog.com/en/1.1.0/[Keep a +Changelog]; this project aims to follow +https://semver.org/spec/v2.0.0.html[Semantic Versioning]. + +=== [Unreleased] + +=== [0.6.0] - 2026-07-17 + +==== Added + +* feat(engine): content facts + `+file-matches-pattern+` — opt-in +`+FactSet.file_contents+` (`+collect_opts+`, valid-UTF-8 files ≤ 1 MiB), +omitted from the default snapshot so the v0.4 wire contract stays +byte-identical. The condition’s regex is validated at load +(`+InvalidRegex+`) so evaluation stays total; false when a file’s +content was not collected. `+plasma check+`/`+fix+` collect content +automatically iff the policy needs it; `+plasma facts --with-contents+` +forces it (`+plasma-engine/src/{facts,eval,schema,ast}.rs+`) +* feat(engine): `+CreateFile+` fix action — a required file at a +_concrete_ path (not a glob) that is missing is created with obvious +placeholder content, never overwriting an existing file; glob-named +required files stay manual (`+plasma-engine/src/{action,apply}.rs+`) +* docs: content-facts + overlay/action updates across +`+engine-v0-design.adoc+`, `+interchange-contracts.adoc+`, +`+cli-design.adoc+` + +=== [0.5.0] - 2026-07-16 + +==== Added + +* feat(engine): overlay `+override-rules+` semantics — an overlay +removes base rules by id from the effective set, and may pair an +override with an `+add-rules+` reusing the same id to _replace_ a rule +(e.g. relax a severity or exempt a zone). `+override-rules+` targeting +an unknown base id is a load error; `+modify-rules+` remains reserved. +The evaluator and the action planner share one `+effective_rules+` set, +so a finding never resolves to an overridden rule +(`+plasma-engine/src/{eval,schema,action}.rs+`) +* docs: overlay-algebra section in `+docs/engine-v0-design.adoc+` + +=== [0.4.0] - 2026-07-16 + +==== Added + +* feat(engine): `+diff(before, after) -> FactsDiff+` — pure, +deterministic comparison of two fact snapshots: files added/removed, +SPDX header transitions, metadata changes, git state +(`+plasma-engine/src/diff.rs+`) +* feat(cli): `+plasma diff before.json after.json+` with diff(1) exit +semantics (0 identical, 1 differ, 2 error) — the before/after +verification protocol for agent claims +* docs: `+docs/interchange-contracts.adoc+` — pins the four wire +contracts (facts snapshot, facts diff, findings JSON, SARIF namespace) +that sibling tools build against; additive-only evolution within a major + +=== [0.3.0] - 2026-07-16 + +==== Added + +* feat(engine): action planner — pure `+plan(policy, evaluation, ctx)+` +maps violations to corrective actions or a manual list with reasons; IO +boundary `+apply(plan, root, opts)+` executes them with `+.bak+` backups +and idempotent skips (`+plasma-engine/src/action.rs+`, `+apply.rs+`) +* feat(cli): `+plasma fix+` — dry-run by default, `+--apply+` to make +changes, +`+--license+`/`+--author+`/`+--no-backup+`/`+--format human|json+`. +First auto-action: AddSpdxHeader; missing files / unparsable headers → +manual +* docs: "`Action planner`" section in `+docs/engine-v0-design.adoc+`; +`+plasma fix+` documented in `+docs/cli-design.adoc+` +* test: `+tests/fix_selftest.rs+` (dry-run, apply+backup, idempotency, +json) + +=== [0.2.0] - 2026-07-02 + +Identity pivot: palimpsest-plasma is a deterministic, typed policy +engine for the agentic era. The Palimpsest license (PMPL) becomes a +separate future project. + +==== Added + +* feat(engine): new `+plasma-engine+` crate — typed policy AST (deontic +modalities, composable conditions, overlays), versioned TOML/JSON schema +loading with load-time rejection of reserved constructs, deterministic +fact collection, a pure/total evaluator, human/JSON/SARIF rendering +* feat(cli): `+plasma check+` (policy evaluation, exit-code gated), +`+plasma facts+` (deterministic fact snapshot), +`+plasma policy validate+` +* feat(cli): bundled repo-hygiene policy; the repo checks itself in +tests +* feat(parser): `+scan_repo+` — deterministic zone-aware repository +scanner +* feat(parser): raw SPDX header extraction +(`+extract_spdx_raw_from_content+`) +* docs: `+docs/engine-v0-design.adoc+` — normative semantics and +Catala-readiness guarantees + +==== Changed + +* *BREAKING*: binary renamed `+palimpsest-plasma+` → `+plasma+` +* *BREAKING*: licensing unified — code MPL-2.0, documentation +CC-BY-SA-4.0; all SPDX headers swept (PMPL/PPMPL identifiers survive +only as parseable inputs to plasma-parser) +* `+plasma audit+` rewritten on plasma-parser (real SPDX expression +parsing, `+.plasma.toml+` zone awareness) instead of substring matching +* `+plasma init+`/`+migrate+`/`+badge+` genericized to any SPDX license +(MPL-2.0 default); Covenant embedding removed +* Root crate moved to edition 2021; workspace versions unified at 0.2.0 +* README/EXPLAINME/TOPOLOGY/ROADMAP/architecture/cli-design rewritten to +describe what exists (the OCaml engine described previously was never +built; the design lives on in docs/policy-ast-v0.1.adoc as lineage) + +==== Fixed + +* Workspace compiles again (init/migrate embedded a nonexistent license +file) +* SPDX catalog PMPL/PPMPL identifier drift (2 failing tests now pass) +* codemeta.json/CITATION.cff described an unrelated boilerplate project + +==== Removed + +* union-policy-parser sub-project (mostly non-compiling scaffolding; +preserved in git history, belongs in its own repository) +* Corrupted `+LICENSE-PMPL-2.0.txt+`, stale MVP release tarballs, badge +pack, signature files of removed artifacts, `+PALIMPSEST-COVENANT.md+`, +`+docs/mvp-v1.adoc+` + +=== [0.1.0] - 2026-05/06 (previously listed as Unreleased) + +==== Added + +* feat(crg): add crg-grade and crg-badge justfile recipes (#5) +* feat(crg): add crg-grade and crg-badge justfile recipes +* feat: add stapeln.toml container definition (#3) +* feat: deploy UX Manifesto infrastructure +* feat: add plasma-parser library crate (40 tests passing) +* feat: plasma CLI — one-command PMPL-2.0 adoption toolkit +* feat: add CLADE.a2ml — clade taxonomy declaration +* feat: integrate PLASMA engine architecture, Policy AST, and +contractiles design +* feat: add CITATION.cff, codemeta.json, and .well-known/ files +* feat(site): replace jekyll with nimblepublisher pages deployment + +==== Fixed + +* fix(ci): bump a2ml/k9-validate-action pins to canonical (standards#85) +(#14) +* fix(ci): sync hypatia-scan.yml to canonical (kill cd-scanner build +drift) (#13) +* fix(ci): build Hypatia escript from repo root (estate dogfood drift) +* fix(ci): rsr-antipattern.yml duplicate heredoc (#11) +* fix(scorecard): enforce granular permissions and add fuzzing +placeholder +* fix(ci): Resolve workflow-linter self-matching and metadata issues +* fix: remove duplicate SCM files from root + +==== Changed + +* refactor: consume contractile CLI instead of reimplementing +* refactor: migrate 6SCM → 6A2 (.scm → .a2ml format) + +==== Documentation + +* docs: MPL-2.0 baseline with Palimpsest overlay wording +* docs: add RSR compliance anchors and archive plasma summary +* docs: add TEST-NEEDS.md and/or PROOF-NEEDS.md from audit +* docs: add family parser specification for palimpsest license variants +* docs: add EXPLAINME.adoc — prove-it file backing README claims +* docs: add CITATION.cff and codemeta.json +* docs: add CONTRIBUTING.md +* docs: refresh audit summaries + +==== CI + +* ci(rust): convert rust-ci.yml to thin wrapper (standards#174) (#20) +* ci: redistribute concurrency-cancel guard to read-only check workflows +(#16) +* ci: fix nonexistent actions/upload-artifact SHA pin (#12) +* ci: bump actions/upload-artifact SHA to current v4 (#10) +* ci(antipattern): fix top-level dir matching + benchmarks/lsp/bench +filename allowlists (#9) + +=== Pre-history + +Prior commits to this file’s introduction are recorded in git history +but not formally classified into Keep-a-Changelog sections. To backfill, +run `+git cliff -o CHANGELOG.md+` locally using the canonical +https://github.com/hyperpolymath/standards/blob/main/templates/cliff.toml[`+cliff.toml+`] +— this is one-shot mechanical work. + +''''' diff --git a/CHANGELOG.md b/CHANGELOG.md deleted file mode 100644 index 14638f4..0000000 --- a/CHANGELOG.md +++ /dev/null @@ -1,186 +0,0 @@ - -# Changelog - -All notable changes to `palimpsest-plasma` will be documented in this file. - -This file is generated from conventional commits by the -[`changelog-reusable.yml`](https://github.com/hyperpolymath/standards/blob/main/.github/workflows/changelog-reusable.yml) -workflow (`hyperpolymath/standards#206`). Adopt the workflow in this repo's CI to keep this file in sync automatically — see -[`templates/cliff.toml`](https://github.com/hyperpolymath/standards/blob/main/templates/cliff.toml) -for the canonical config. - -The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/); -this project aims to follow [Semantic Versioning](https://semver.org/spec/v2.0.0.html). - -## [Unreleased] - -## [0.6.0] - 2026-07-17 - -### Added - -- feat(engine): content facts + `file-matches-pattern` — opt-in - `FactSet.file_contents` (`collect_opts`, valid-UTF-8 files ≤ 1 MiB), - omitted from the default snapshot so the v0.4 wire contract stays - byte-identical. The condition's regex is validated at load - (`InvalidRegex`) so evaluation stays total; false when a file's content - was not collected. `plasma check`/`fix` collect content automatically iff - the policy needs it; `plasma facts --with-contents` forces it - (`plasma-engine/src/{facts,eval,schema,ast}.rs`) -- feat(engine): `CreateFile` fix action — a required file at a *concrete* - path (not a glob) that is missing is created with obvious placeholder - content, never overwriting an existing file; glob-named required files - stay manual (`plasma-engine/src/{action,apply}.rs`) -- docs: content-facts + overlay/action updates across - `engine-v0-design.adoc`, `interchange-contracts.adoc`, `cli-design.adoc` - -## [0.5.0] - 2026-07-16 - -### Added - -- feat(engine): overlay `override-rules` semantics — an overlay removes base - rules by id from the effective set, and may pair an override with an - `add-rules` reusing the same id to *replace* a rule (e.g. relax a severity - or exempt a zone). `override-rules` targeting an unknown base id is a load - error; `modify-rules` remains reserved. The evaluator and the action - planner share one `effective_rules` set, so a finding never resolves to an - overridden rule (`plasma-engine/src/{eval,schema,action}.rs`) -- docs: overlay-algebra section in `docs/engine-v0-design.adoc` - -## [0.4.0] - 2026-07-16 - -### Added - -- feat(engine): `diff(before, after) -> FactsDiff` — pure, deterministic - comparison of two fact snapshots: files added/removed, SPDX header - transitions, metadata changes, git state (`plasma-engine/src/diff.rs`) -- feat(cli): `plasma diff before.json after.json` with diff(1) exit - semantics (0 identical, 1 differ, 2 error) — the before/after - verification protocol for agent claims -- docs: `docs/interchange-contracts.adoc` — pins the four wire contracts - (facts snapshot, facts diff, findings JSON, SARIF namespace) that - sibling tools build against; additive-only evolution within a major - -## [0.3.0] - 2026-07-16 - -### Added - -- feat(engine): action planner — pure `plan(policy, evaluation, ctx)` maps - violations to corrective actions or a manual list with reasons; IO - boundary `apply(plan, root, opts)` executes them with `.bak` backups and - idempotent skips (`plasma-engine/src/action.rs`, `apply.rs`) -- feat(cli): `plasma fix` — dry-run by default, `--apply` to make changes, - `--license`/`--author`/`--no-backup`/`--format human|json`. First - auto-action: AddSpdxHeader; missing files / unparsable headers → manual -- docs: "Action planner" section in `docs/engine-v0-design.adoc`; - `plasma fix` documented in `docs/cli-design.adoc` -- test: `tests/fix_selftest.rs` (dry-run, apply+backup, idempotency, json) - -## [0.2.0] - 2026-07-02 - -Identity pivot: palimpsest-plasma is a deterministic, typed policy engine -for the agentic era. The Palimpsest license (PMPL) becomes a separate -future project. - -### Added - -- feat(engine): new `plasma-engine` crate — typed policy AST (deontic - modalities, composable conditions, overlays), versioned TOML/JSON schema - loading with load-time rejection of reserved constructs, deterministic - fact collection, a pure/total evaluator, human/JSON/SARIF rendering -- feat(cli): `plasma check` (policy evaluation, exit-code gated), - `plasma facts` (deterministic fact snapshot), `plasma policy validate` -- feat(cli): bundled repo-hygiene policy; the repo checks itself in tests -- feat(parser): `scan_repo` — deterministic zone-aware repository scanner -- feat(parser): raw SPDX header extraction (`extract_spdx_raw_from_content`) -- docs: `docs/engine-v0-design.adoc` — normative semantics and - Catala-readiness guarantees - -### Changed - -- **BREAKING**: binary renamed `palimpsest-plasma` → `plasma` -- **BREAKING**: licensing unified — code MPL-2.0, documentation - CC-BY-SA-4.0; all SPDX headers swept (PMPL/PPMPL identifiers survive only - as parseable inputs to plasma-parser) -- `plasma audit` rewritten on plasma-parser (real SPDX expression parsing, - `.plasma.toml` zone awareness) instead of substring matching -- `plasma init`/`migrate`/`badge` genericized to any SPDX license - (MPL-2.0 default); Covenant embedding removed -- Root crate moved to edition 2021; workspace versions unified at 0.2.0 -- README/EXPLAINME/TOPOLOGY/ROADMAP/architecture/cli-design rewritten to - describe what exists (the OCaml engine described previously was never - built; the design lives on in docs/policy-ast-v0.1.adoc as lineage) - -### Fixed - -- Workspace compiles again (init/migrate embedded a nonexistent license - file) -- SPDX catalog PMPL/PPMPL identifier drift (2 failing tests now pass) -- codemeta.json/CITATION.cff described an unrelated boilerplate project - -### Removed - -- union-policy-parser sub-project (mostly non-compiling scaffolding; - preserved in git history, belongs in its own repository) -- Corrupted `LICENSE-PMPL-2.0.txt`, stale MVP release tarballs, badge - pack, signature files of removed artifacts, `PALIMPSEST-COVENANT.md`, - `docs/mvp-v1.adoc` - -## [0.1.0] - 2026-05/06 (previously listed as Unreleased) - -### Added - -- feat(crg): add crg-grade and crg-badge justfile recipes (#5) -- feat(crg): add crg-grade and crg-badge justfile recipes -- feat: add stapeln.toml container definition (#3) -- feat: deploy UX Manifesto infrastructure -- feat: add plasma-parser library crate (40 tests passing) -- feat: plasma CLI — one-command PMPL-2.0 adoption toolkit -- feat: add CLADE.a2ml — clade taxonomy declaration -- feat: integrate PLASMA engine architecture, Policy AST, and contractiles design -- feat: add CITATION.cff, codemeta.json, and .well-known/ files -- feat(site): replace jekyll with nimblepublisher pages deployment - -### Fixed - -- fix(ci): bump a2ml/k9-validate-action pins to canonical (standards#85) (#14) -- fix(ci): sync hypatia-scan.yml to canonical (kill cd-scanner build drift) (#13) -- fix(ci): build Hypatia escript from repo root (estate dogfood drift) -- fix(ci): rsr-antipattern.yml duplicate heredoc (#11) -- fix(scorecard): enforce granular permissions and add fuzzing placeholder -- fix(ci): Resolve workflow-linter self-matching and metadata issues -- fix: remove duplicate SCM files from root - -### Changed - -- refactor: consume contractile CLI instead of reimplementing -- refactor: migrate 6SCM → 6A2 (.scm → .a2ml format) - -### Documentation - -- docs: MPL-2.0 baseline with Palimpsest overlay wording -- docs: add RSR compliance anchors and archive plasma summary -- docs: add TEST-NEEDS.md and/or PROOF-NEEDS.md from audit -- docs: add family parser specification for palimpsest license variants -- docs: add EXPLAINME.adoc — prove-it file backing README claims -- docs: add CITATION.cff and codemeta.json -- docs: add CONTRIBUTING.md -- docs: refresh audit summaries - -### CI - -- ci(rust): convert rust-ci.yml to thin wrapper (standards#174) (#20) -- ci: redistribute concurrency-cancel guard to read-only check workflows (#16) -- ci: fix nonexistent actions/upload-artifact SHA pin (#12) -- ci: bump actions/upload-artifact SHA to current v4 (#10) -- ci(antipattern): fix top-level dir matching + benchmarks/lsp/bench filename allowlists (#9) - -## Pre-history - -Prior commits to this file's introduction are recorded in git history but not formally classified into Keep-a-Changelog sections. To backfill, run `git cliff -o CHANGELOG.md` locally using the canonical [`cliff.toml`](https://github.com/hyperpolymath/standards/blob/main/templates/cliff.toml) — this is one-shot mechanical work. - ---- - - diff --git a/CODE_OF_CONDUCT.adoc b/CODE_OF_CONDUCT.adoc new file mode 100644 index 0000000..8d30d71 --- /dev/null +++ b/CODE_OF_CONDUCT.adoc @@ -0,0 +1,339 @@ +== Code of Conduct + +=== Our Pledge + +We as members, contributors, and leaders pledge to make participation in +Palimpsest Plasma a harassment-free experience for everyone, regardless +of age, body size, visible or invisible disability, ethnicity, sex +characteristics, gender identity and expression, level of experience, +education, socio-economic status, nationality, personal appearance, +race, caste, colour, religion, or sexual identity and orientation. + +We pledge to act and interact in ways that contribute to an open, +welcoming, diverse, inclusive, and healthy community. + +We recognise that a thriving open source community requires +*psychological safety* — an environment where people can contribute, ask +questions, make mistakes, and learn without fear of ridicule or +retaliation. + +''''' + +=== Our Standards + +==== Expected Behaviour + +The following behaviours contribute to a positive environment: + +*Communication* - Using welcoming and inclusive language - Being +respectful of differing viewpoints and experiences - Giving and +gracefully accepting constructive feedback - Assuming good intent while +addressing impact - Communicating clearly and patiently, especially with +newcomers + +*Collaboration* - Focusing on what is best for the community - Showing +empathy and kindness toward other community members - Being +collaborative rather than competitive - Mentoring and supporting less +experienced contributors - Celebrating others’ contributions and +successes + +*Professionalism* - Accepting responsibility and apologising to those +affected by our mistakes - Learning from the experience and avoiding +repetition - Respecting others’ time and attention - Staying on topic in +project spaces - Following project guidelines and conventions + +*Accessibility* - Using plain language and avoiding unnecessary jargon - +Providing alt text for images and transcripts for audio/video - Being +patient with those using assistive technologies - Accommodating +different communication styles and needs - Recognising that not everyone +communicates the same way + +==== Unacceptable Behaviour + +The following behaviours are considered harassment and are unacceptable: + +*Harassment* - The use of sexualised language or imagery, and sexual +attention or advances of any kind - Trolling, insulting or derogatory +comments, and personal or political attacks - Public or private +harassment - Deliberate intimidation, stalking, or following (online or +in-person) - Unwelcome physical contact or simulated physical contact +(e.g., emoji) - Sustained disruption of talks, events, or online +discussions + +*Discrimination* - Discriminatory jokes and language - Posting or +threatening to post others’ personally identifying information +("`doxing`") - Advocating for, or encouraging, any of the above +behaviour - Microaggressions — subtle, often unintentional, +discriminatory comments or actions + +*Professional Misconduct* - Publishing others’ private information +without explicit permission - Misrepresenting affiliation or +contributions - Plagiarism or claiming credit for others’ work - +Retaliating against anyone who reports a Code of Conduct violation - +Other conduct which could reasonably be considered inappropriate in a +professional setting + +==== Grey Areas + +Some situations require judgement. When uncertain: + +* *Intent vs Impact*: Good intentions do not excuse harmful impact. +Focus on making things right. +* *Power Dynamics*: Those with more power (maintainers, employers, +experienced contributors) must be especially mindful of their impact. +* *Cultural Differences*: What’s acceptable varies by culture. When in +doubt, err on the side of caution and ask. +* *Humour*: Jokes at others’ expense are rarely funny to everyone. Punch +up, not down. + +''''' + +=== Scope + +This Code of Conduct applies within all community spaces, including: + +*Online Spaces* - Repository discussions, issues, and pull/merge +requests - Project chat channels (Matrix, Discord, Slack, IRC) - Mailing +lists and forums - Social media when representing the project - Video +calls and virtual meetings + +*In-Person Spaces* - Conferences, meetups, and events - Workshops and +training sessions - Any gathering where you represent the project + +*Representation* This Code of Conduct also applies when an individual is +officially representing the community in public spaces. Examples +include: + +* Using an official project email address +* Posting via an official social media account +* Acting as an appointed representative at an event +* Speaking on behalf of the project + +''''' + +=== Enforcement + +==== Reporting + +If you experience or witness unacceptable behaviour, or have any other +concerns, please report it as soon as possible. + +*How to Report* + +[width="99%",cols="30%,33%,37%",options="header",] +|=== +|Method |Details |Best For +|*Email* |\{\{CONDUCT_EMAIL}} |Detailed reports, sensitive matters + +|*Private Message* |Contact any maintainer directly |Quick questions, +minor issues + +|*Anonymous Form* |[Link to form if available] |When you need anonymity +|=== + +*What to Include* + +* Your contact information (unless anonymous) +* Names/usernames of those involved +* Description of what happened +* When and where it occurred +* Any witnesses +* Any supporting evidence (screenshots, links) +* How you would like us to respond (if you have a preference) + +*What Happens Next* + +[arabic] +. You will receive acknowledgment within *\{\{RESPONSE_TIME}}* +. The \{\{CONDUCT_TEAM}} will review the report +. We may ask for additional information +. We will determine appropriate action +. We will inform you of the outcome (respecting others’ privacy) + +==== Confidentiality + +All reports will be handled with discretion: + +* Reporter identity is protected by default +* Details are shared only with those who need to know +* We will ask before naming you in any communication +* Anonymous reports are accepted and investigated + +==== Conflicts of Interest + +If a \{\{CONDUCT_TEAM}} member is involved in an incident: + +* They will recuse themselves from the process +* Another maintainer or external party will handle the report +* We will disclose any potential conflicts + +''''' + +=== Enforcement Guidelines + +The \{\{CONDUCT_TEAM}} will follow these guidelines in determining +consequences: + +==== 1. Correction + +*Community Impact*: Use of inappropriate language or other behaviour +deemed unprofessional or unwelcome. + +*Consequence*: A private, written warning providing clarity around the +nature of the violation and an explanation of why the behaviour was +inappropriate. A public apology may be requested. + +*Duration*: Immediate + +==== 2. Warning + +*Community Impact*: A violation through a single incident or series of +actions. + +*Consequence*: A warning with consequences for continued behaviour. No +interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, for a specified period. This +includes avoiding interactions in community spaces as well as external +channels like social media. Violating these terms may lead to a +temporary or permanent ban. + +*Duration*: 1-4 weeks + +==== 3. Temporary Ban + +*Community Impact*: A serious violation of community standards, +including sustained inappropriate behaviour. + +*Consequence*: A temporary ban from any sort of interaction or public +communication with the community for a specified period. No public or +private interaction with the people involved, including unsolicited +interaction with those enforcing the Code of Conduct, is allowed during +this period. Violating these terms may lead to a permanent ban. + +*Duration*: 1-6 months + +==== 4. Permanent Ban + +*Community Impact*: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behaviour, harassment of an +individual, or aggression toward or disparagement of classes of +individuals. + +*Consequence*: A permanent ban from any sort of public interaction +within the community. + +*Duration*: Permanent (with appeal rights after 12 months) + +==== Enforcement Across Perimeters + +For contributors with elevated access (Perimeter 2 or 1): + +[cols=",",options="header",] +|=== +|Level |Additional Consequence +|Correction |Noted in contributor record +|Warning |Access privileges may be temporarily reduced +|Temporary Ban |Access reduced to Perimeter 3 for ban duration +|Permanent Ban |All access revoked +|=== + +''''' + +=== Appeals + +If you believe an enforcement decision was made in error: + +[arabic] +. *Wait 7 days* after the decision (cooling-off period) +. *Email* \{\{CONDUCT_EMAIL}} with subject line "`Appeal: [Original +Report ID]`" +. *Explain* why you believe the decision should be reconsidered +. *Provide* any new information not previously available + +*Appeals Process* + +* Appeals are reviewed by a different \{\{CONDUCT_TEAM}} member than the +original +* You will receive a response within 14 days +* The appeals decision is final +* You may only appeal once per incident + +*Grounds for Appeal* + +* Procedural errors in the original investigation +* New evidence not previously available +* Disproportionate response to the violation +* Misunderstanding of facts + +''''' + +=== Supporting Those Who Report + +We are committed to supporting those who report violations: + +*We Will* - Believe and take all reports seriously - Respect your +privacy and confidentiality preferences - Keep you informed of progress +(if you wish) - Take steps to protect you from retaliation - Provide +resources if you need support + +*We Will Not* - Require you to confront the person directly - Dismiss +reports without investigation - Reveal your identity without consent - +Tolerate retaliation against reporters - Rush you to make decisions + +''''' + +=== Prevention + +Beyond enforcement, we actively work to prevent issues: + +*Onboarding* - All contributors are expected to read this Code of +Conduct - Perimeter 2 applicants must confirm they’ve read and +understood it - Maintainers receive additional training on enforcement + +*Culture* - We model the behaviour we expect - We intervene early when +we see potential issues - We thank people for positive contributions - +We create opportunities for diverse voices + +*Review* - This Code of Conduct is reviewed annually - Community +feedback is welcomed - Changes are communicated clearly + +''''' + +=== Acknowledgments + +This Code of Conduct is adapted from: + +* https://www.contributor-covenant.org/[Contributor Covenant], version +2.1 +* https://www.djangoproject.com/conduct/[Django Code of Conduct] +* https://www.rust-lang.org/policies/code-of-conduct[Rust Code of +Conduct] +* https://www.python.org/psf/conduct/[Python Community Code of Conduct] + +We thank these communities for their leadership in creating welcoming +spaces. + +''''' + +=== Questions? + +If you have questions about this Code of Conduct: + +* Open a +https://github.com/hyperpolymath/palimpsest-plasma/discussions[Discussion] +(for general questions) +* Email \{\{CONDUCT_EMAIL}} (for private questions) +* Contact any maintainer directly + +''''' + +=== Summary + +*Be kind. Be respectful. Be collaborative.* + +We’re all here because we care about this project. Let’s make it a place +where everyone can do their best work. + +''''' + +Last updated: 2026 · Based on Contributor Covenant 2.1 diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md deleted file mode 100644 index c3eb8dd..0000000 --- a/CODE_OF_CONDUCT.md +++ /dev/null @@ -1,331 +0,0 @@ - -# Code of Conduct - - - -## Our Pledge - -We as members, contributors, and leaders pledge to make participation in Palimpsest Plasma a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, colour, religion, or sexual identity and orientation. - -We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community. - -We recognise that a thriving open source community requires **psychological safety** — an environment where people can contribute, ask questions, make mistakes, and learn without fear of ridicule or retaliation. - ---- - -## Our Standards - -### Expected Behaviour - -The following behaviours contribute to a positive environment: - -**Communication** -- Using welcoming and inclusive language -- Being respectful of differing viewpoints and experiences -- Giving and gracefully accepting constructive feedback -- Assuming good intent while addressing impact -- Communicating clearly and patiently, especially with newcomers - -**Collaboration** -- Focusing on what is best for the community -- Showing empathy and kindness toward other community members -- Being collaborative rather than competitive -- Mentoring and supporting less experienced contributors -- Celebrating others' contributions and successes - -**Professionalism** -- Accepting responsibility and apologising to those affected by our mistakes -- Learning from the experience and avoiding repetition -- Respecting others' time and attention -- Staying on topic in project spaces -- Following project guidelines and conventions - -**Accessibility** -- Using plain language and avoiding unnecessary jargon -- Providing alt text for images and transcripts for audio/video -- Being patient with those using assistive technologies -- Accommodating different communication styles and needs -- Recognising that not everyone communicates the same way - -### Unacceptable Behaviour - -The following behaviours are considered harassment and are unacceptable: - -**Harassment** -- The use of sexualised language or imagery, and sexual attention or advances of any kind -- Trolling, insulting or derogatory comments, and personal or political attacks -- Public or private harassment -- Deliberate intimidation, stalking, or following (online or in-person) -- Unwelcome physical contact or simulated physical contact (e.g., emoji) -- Sustained disruption of talks, events, or online discussions - -**Discrimination** -- Discriminatory jokes and language -- Posting or threatening to post others' personally identifying information ("doxing") -- Advocating for, or encouraging, any of the above behaviour -- Microaggressions — subtle, often unintentional, discriminatory comments or actions - -**Professional Misconduct** -- Publishing others' private information without explicit permission -- Misrepresenting affiliation or contributions -- Plagiarism or claiming credit for others' work -- Retaliating against anyone who reports a Code of Conduct violation -- Other conduct which could reasonably be considered inappropriate in a professional setting - -### Grey Areas - -Some situations require judgement. When uncertain: - -- **Intent vs Impact**: Good intentions do not excuse harmful impact. Focus on making things right. -- **Power Dynamics**: Those with more power (maintainers, employers, experienced contributors) must be especially mindful of their impact. -- **Cultural Differences**: What's acceptable varies by culture. When in doubt, err on the side of caution and ask. -- **Humour**: Jokes at others' expense are rarely funny to everyone. Punch up, not down. - ---- - -## Scope - -This Code of Conduct applies within all community spaces, including: - -**Online Spaces** -- Repository discussions, issues, and pull/merge requests -- Project chat channels (Matrix, Discord, Slack, IRC) -- Mailing lists and forums -- Social media when representing the project -- Video calls and virtual meetings - -**In-Person Spaces** -- Conferences, meetups, and events -- Workshops and training sessions -- Any gathering where you represent the project - -**Representation** -This Code of Conduct also applies when an individual is officially representing the community in public spaces. Examples include: - -- Using an official project email address -- Posting via an official social media account -- Acting as an appointed representative at an event -- Speaking on behalf of the project - ---- - -## Enforcement - -### Reporting - -If you experience or witness unacceptable behaviour, or have any other concerns, please report it as soon as possible. - -**How to Report** - -| Method | Details | Best For | -|--------|---------|----------| -| **Email** | {{CONDUCT_EMAIL}} | Detailed reports, sensitive matters | -| **Private Message** | Contact any maintainer directly | Quick questions, minor issues | -| **Anonymous Form** | [Link to form if available] | When you need anonymity | - -**What to Include** - -- Your contact information (unless anonymous) -- Names/usernames of those involved -- Description of what happened -- When and where it occurred -- Any witnesses -- Any supporting evidence (screenshots, links) -- How you would like us to respond (if you have a preference) - -**What Happens Next** - -1. You will receive acknowledgment within **{{RESPONSE_TIME}}** -2. The {{CONDUCT_TEAM}} will review the report -3. We may ask for additional information -4. We will determine appropriate action -5. We will inform you of the outcome (respecting others' privacy) - -### Confidentiality - -All reports will be handled with discretion: - -- Reporter identity is protected by default -- Details are shared only with those who need to know -- We will ask before naming you in any communication -- Anonymous reports are accepted and investigated - -### Conflicts of Interest - -If a {{CONDUCT_TEAM}} member is involved in an incident: - -- They will recuse themselves from the process -- Another maintainer or external party will handle the report -- We will disclose any potential conflicts - ---- - -## Enforcement Guidelines - -The {{CONDUCT_TEAM}} will follow these guidelines in determining consequences: - -### 1. Correction - -**Community Impact**: Use of inappropriate language or other behaviour deemed unprofessional or unwelcome. - -**Consequence**: A private, written warning providing clarity around the nature of the violation and an explanation of why the behaviour was inappropriate. A public apology may be requested. - -**Duration**: Immediate - -### 2. Warning - -**Community Impact**: A violation through a single incident or series of actions. - -**Consequence**: A warning with consequences for continued behaviour. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban. - -**Duration**: 1-4 weeks - -### 3. Temporary Ban - -**Community Impact**: A serious violation of community standards, including sustained inappropriate behaviour. - -**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban. - -**Duration**: 1-6 months - -### 4. Permanent Ban - -**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behaviour, harassment of an individual, or aggression toward or disparagement of classes of individuals. - -**Consequence**: A permanent ban from any sort of public interaction within the community. - -**Duration**: Permanent (with appeal rights after 12 months) - -### Enforcement Across Perimeters - -For contributors with elevated access (Perimeter 2 or 1): - -| Level | Additional Consequence | -|-------|----------------------| -| Correction | Noted in contributor record | -| Warning | Access privileges may be temporarily reduced | -| Temporary Ban | Access reduced to Perimeter 3 for ban duration | -| Permanent Ban | All access revoked | - ---- - -## Appeals - -If you believe an enforcement decision was made in error: - -1. **Wait 7 days** after the decision (cooling-off period) -2. **Email** {{CONDUCT_EMAIL}} with subject line "Appeal: [Original Report ID]" -3. **Explain** why you believe the decision should be reconsidered -4. **Provide** any new information not previously available - -**Appeals Process** - -- Appeals are reviewed by a different {{CONDUCT_TEAM}} member than the original -- You will receive a response within 14 days -- The appeals decision is final -- You may only appeal once per incident - -**Grounds for Appeal** - -- Procedural errors in the original investigation -- New evidence not previously available -- Disproportionate response to the violation -- Misunderstanding of facts - ---- - -## Supporting Those Who Report - -We are committed to supporting those who report violations: - -**We Will** -- Believe and take all reports seriously -- Respect your privacy and confidentiality preferences -- Keep you informed of progress (if you wish) -- Take steps to protect you from retaliation -- Provide resources if you need support - -**We Will Not** -- Require you to confront the person directly -- Dismiss reports without investigation -- Reveal your identity without consent -- Tolerate retaliation against reporters -- Rush you to make decisions - ---- - -## Prevention - -Beyond enforcement, we actively work to prevent issues: - -**Onboarding** -- All contributors are expected to read this Code of Conduct -- Perimeter 2 applicants must confirm they've read and understood it -- Maintainers receive additional training on enforcement - -**Culture** -- We model the behaviour we expect -- We intervene early when we see potential issues -- We thank people for positive contributions -- We create opportunities for diverse voices - -**Review** -- This Code of Conduct is reviewed annually -- Community feedback is welcomed -- Changes are communicated clearly - ---- - -## Acknowledgments - -This Code of Conduct is adapted from: - -- [Contributor Covenant](https://www.contributor-covenant.org/), version 2.1 -- [Django Code of Conduct](https://www.djangoproject.com/conduct/) -- [Rust Code of Conduct](https://www.rust-lang.org/policies/code-of-conduct) -- [Python Community Code of Conduct](https://www.python.org/psf/conduct/) - -We thank these communities for their leadership in creating welcoming spaces. - ---- - -## Questions? - -If you have questions about this Code of Conduct: - -- Open a [Discussion](https://github.com/hyperpolymath/palimpsest-plasma/discussions) (for general questions) -- Email {{CONDUCT_EMAIL}} (for private questions) -- Contact any maintainer directly - ---- - -## Summary - -**Be kind. Be respectful. Be collaborative.** - -We're all here because we care about this project. Let's make it a place where everyone can do their best work. - ---- - -Last updated: 2026 · Based on Contributor Covenant 2.1 diff --git a/CONTRIBUTING.adoc b/CONTRIBUTING.adoc new file mode 100644 index 0000000..6029495 --- /dev/null +++ b/CONTRIBUTING.adoc @@ -0,0 +1,109 @@ +== Clone the repository + +git clone https://github.com/hyperpolymath/palimpsest-plasma.git cd +palimpsest-plasma + +== Using Nix (recommended for reproducibility) + +nix develop + +== Or using toolbox/distrobox + +toolbox create palimpsest-plasma-dev toolbox enter palimpsest-plasma-dev +# Install dependencies manually + +== Verify setup + +just check # or: cargo check / mix compile / etc. just test # Run test +suite + +.... + +### Repository Structure +.... + +palimpsest-plasma/ ├── src/ # Source code (Perimeter 1-2) ├── lib/ # +Library code (Perimeter 1-2) ├── extensions/ # Extensions (Perimeter 2) +├── plugins/ # Plugins (Perimeter 2) ├── tools/ # Tooling (Perimeter 2) +├── docs/ # Documentation (Perimeter 3) │ ├── architecture/ # ADRs, +specs (Perimeter 2) │ └── proposals/ # RFCs (Perimeter 3) ├── examples/ +# Examples (Perimeter 3) ├── spec/ # Spec tests (Perimeter 3) ├── tests/ +# Test suite (Perimeter 2-3) ├── .well-known/ # Protocol files +(Perimeter 1-3) ├── .github/ # GitHub config (Perimeter 1) │ ├── +ISSUE_TEMPLATE/ │ └── workflows/ ├── CHANGELOG.md ├── CODE_OF_CONDUCT.md +├── CONTRIBUTING.md # This file ├── GOVERNANCE.md ├── LICENSE ├── +MAINTAINERS.md ├── README.adoc ├── SECURITY.md ├── flake.nix # Nix flake +(Perimeter 1) └── Justfile # Task runner (Perimeter 1) + +.... + +--- + +## How to Contribute + +### Reporting Bugs + +**Before reporting**: +1. Search existing issues +2. Check if it's already fixed in `main` +3. Determine which perimeter the bug affects + +**When reporting**: + +Use the [bug report template](.github/ISSUE_TEMPLATE/bug_report.md) and include: + +- Clear, descriptive title +- Environment details (OS, versions, toolchain) +- Steps to reproduce +- Expected vs actual behaviour +- Logs, screenshots, or minimal reproduction + +### Suggesting Features + +**Before suggesting**: +1. Check the [roadmap](ROADMAP.md) if available +2. Search existing issues and discussions +3. Consider which perimeter the feature belongs to + +**When suggesting**: + +Use the [feature request template](.github/ISSUE_TEMPLATE/feature_request.md) and include: + +- Problem statement (what pain point does this solve?) +- Proposed solution +- Alternatives considered +- Which perimeter this affects + +### Your First Contribution + +Look for issues labelled: + +- [`good first issue`](https://github.com/hyperpolymath/palimpsest-plasma/labels/good%20first%20issue) — Simple Perimeter 3 tasks +- [`help wanted`](https://github.com/hyperpolymath/palimpsest-plasma/labels/help%20wanted) — Community help needed +- [`documentation`](https://github.com/hyperpolymath/palimpsest-plasma/labels/documentation) — Docs improvements +- [`perimeter-3`](https://github.com/hyperpolymath/palimpsest-plasma/labels/perimeter-3) — Community sandbox scope + +--- + +## Development Workflow + +### Branch Naming +.... + +docs/short-description # Documentation (P3) test/what-added # Test +additions (P3) feat/short-description # New features (P2) +fix/issue-number-description # Bug fixes (P2) refactor/what-changed # +Code improvements (P2) security/what-fixed # Security fixes (P1-2) + +.... + +### Commit Messages + +We follow [Conventional Commits](https://www.conventionalcommits.org/): +.... + +(): + +{empty}[optional body] + +{empty}[optional footer] diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index c60d14e..0000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,120 +0,0 @@ - -# Clone the repository -git clone https://github.com/hyperpolymath/palimpsest-plasma.git -cd palimpsest-plasma - -# Using Nix (recommended for reproducibility) -nix develop - -# Or using toolbox/distrobox -toolbox create palimpsest-plasma-dev -toolbox enter palimpsest-plasma-dev -# Install dependencies manually - -# Verify setup -just check # or: cargo check / mix compile / etc. -just test # Run test suite -``` - -### Repository Structure -``` -palimpsest-plasma/ -├── src/ # Source code (Perimeter 1-2) -├── lib/ # Library code (Perimeter 1-2) -├── extensions/ # Extensions (Perimeter 2) -├── plugins/ # Plugins (Perimeter 2) -├── tools/ # Tooling (Perimeter 2) -├── docs/ # Documentation (Perimeter 3) -│ ├── architecture/ # ADRs, specs (Perimeter 2) -│ └── proposals/ # RFCs (Perimeter 3) -├── examples/ # Examples (Perimeter 3) -├── spec/ # Spec tests (Perimeter 3) -├── tests/ # Test suite (Perimeter 2-3) -├── .well-known/ # Protocol files (Perimeter 1-3) -├── .github/ # GitHub config (Perimeter 1) -│ ├── ISSUE_TEMPLATE/ -│ └── workflows/ -├── CHANGELOG.md -├── CODE_OF_CONDUCT.md -├── CONTRIBUTING.md # This file -├── GOVERNANCE.md -├── LICENSE -├── MAINTAINERS.md -├── README.adoc -├── SECURITY.md -├── flake.nix # Nix flake (Perimeter 1) -└── Justfile # Task runner (Perimeter 1) -``` - ---- - -## How to Contribute - -### Reporting Bugs - -**Before reporting**: -1. Search existing issues -2. Check if it's already fixed in `main` -3. Determine which perimeter the bug affects - -**When reporting**: - -Use the [bug report template](.github/ISSUE_TEMPLATE/bug_report.md) and include: - -- Clear, descriptive title -- Environment details (OS, versions, toolchain) -- Steps to reproduce -- Expected vs actual behaviour -- Logs, screenshots, or minimal reproduction - -### Suggesting Features - -**Before suggesting**: -1. Check the [roadmap](ROADMAP.md) if available -2. Search existing issues and discussions -3. Consider which perimeter the feature belongs to - -**When suggesting**: - -Use the [feature request template](.github/ISSUE_TEMPLATE/feature_request.md) and include: - -- Problem statement (what pain point does this solve?) -- Proposed solution -- Alternatives considered -- Which perimeter this affects - -### Your First Contribution - -Look for issues labelled: - -- [`good first issue`](https://github.com/hyperpolymath/palimpsest-plasma/labels/good%20first%20issue) — Simple Perimeter 3 tasks -- [`help wanted`](https://github.com/hyperpolymath/palimpsest-plasma/labels/help%20wanted) — Community help needed -- [`documentation`](https://github.com/hyperpolymath/palimpsest-plasma/labels/documentation) — Docs improvements -- [`perimeter-3`](https://github.com/hyperpolymath/palimpsest-plasma/labels/perimeter-3) — Community sandbox scope - ---- - -## Development Workflow - -### Branch Naming -``` -docs/short-description # Documentation (P3) -test/what-added # Test additions (P3) -feat/short-description # New features (P2) -fix/issue-number-description # Bug fixes (P2) -refactor/what-changed # Code improvements (P2) -security/what-fixed # Security fixes (P1-2) -``` - -### Commit Messages - -We follow [Conventional Commits](https://www.conventionalcommits.org/): -``` -(): - -[optional body] - -[optional footer] diff --git a/GOVERNANCE.adoc b/GOVERNANCE.adoc new file mode 100644 index 0000000..9b836fb --- /dev/null +++ b/GOVERNANCE.adoc @@ -0,0 +1,60 @@ +== Governance + +=== Overview + +This project is governed by the following principles and structures to +ensure transparent, inclusive, and effective decision-making. + +=== Roles and Responsibilities + +==== Maintainers + +Maintainers are responsible for: - Reviewing and merging pull requests - +Managing releases and versioning - Ensuring code quality and standards - +Triaging issues and bug reports - Community engagement and support + +==== Contributors + +Contributors are expected to: - Follow the code of conduct - Submit +well-documented pull requests - Write tests for new functionality - +Maintain existing tests - Update documentation as needed + +=== Decision Making + +==== Minor Changes + +* Can be made by any maintainer +* Include bug fixes, documentation updates, dependency updates + +==== Major Changes + +* Require discussion in issues or pull requests +* Include new features, architectural changes, API changes +* Need approval from at least 2 maintainers + +==== Breaking Changes + +* Require RFC (Request for Comments) process +* Need approval from majority of maintainers +* Must include migration guide + +=== Code of Conduct + +All participants are expected to follow our Code of Conduct. Violations +can be reported to the maintainers. + +=== Communication + +* *Issues*: For bug reports and feature requests +* *Discussions*: For questions and general discussion +* *Pull Requests*: For code contributions + +=== Licensing + +All contributions are made under the terms of the repository’s LICENSE +file. By submitting a pull request, you agree to license your +contributions accordingly. + +''''' + +_Last updated: 2026-07-18_ diff --git a/GOVERNANCE.md b/GOVERNANCE.md deleted file mode 100644 index e27364c..0000000 --- a/GOVERNANCE.md +++ /dev/null @@ -1,60 +0,0 @@ -# Governance - -## Overview - -This project is governed by the following principles and structures to ensure transparent, inclusive, and effective decision-making. - -## Roles and Responsibilities - -### Maintainers - -Maintainers are responsible for: -- Reviewing and merging pull requests -- Managing releases and versioning -- Ensuring code quality and standards -- Triaging issues and bug reports -- Community engagement and support - -### Contributors - -Contributors are expected to: -- Follow the code of conduct -- Submit well-documented pull requests -- Write tests for new functionality -- Maintain existing tests -- Update documentation as needed - -## Decision Making - -### Minor Changes -- Can be made by any maintainer -- Include bug fixes, documentation updates, dependency updates - -### Major Changes -- Require discussion in issues or pull requests -- Include new features, architectural changes, API changes -- Need approval from at least 2 maintainers - -### Breaking Changes -- Require RFC (Request for Comments) process -- Need approval from majority of maintainers -- Must include migration guide - -## Code of Conduct - -All participants are expected to follow our Code of Conduct. Violations can be reported to the maintainers. - -## Communication - -- **Issues**: For bug reports and feature requests -- **Discussions**: For questions and general discussion -- **Pull Requests**: For code contributions - -## Licensing - -All contributions are made under the terms of the repository's LICENSE file. -By submitting a pull request, you agree to license your contributions accordingly. - ---- - -*Last updated: 2026-07-18* diff --git a/PROOF-NEEDS.adoc b/PROOF-NEEDS.adoc new file mode 100644 index 0000000..65b9c2d --- /dev/null +++ b/PROOF-NEEDS.adoc @@ -0,0 +1,39 @@ +== PROOF-NEEDS.md — palimpsest-plasma + +=== Current State + +* **src/abi/*.idr**: NO +* *Dangerous patterns*: 18 `+unwrap()+` in Rust code +* *LOC*: ~6,900 (Rust) +* *ABI layer*: Missing + +=== What Needs Proving + +[width="100%",cols="51%,27%,22%",options="header",] +|=== +|Component |What |Why +|SPDX parser correctness |Parser accepts all valid SPDX expressions and +rejects invalid ones |Wrong SPDX parsing causes license +misidentification + +|License family registry |Family classification is complete and +consistent |Misclassified licenses create compliance risk + +|Union policy parser |Policy composition preserves individual license +requirements |Composed policies must not lose restrictions + +|Content audit |Audit detection is sound (no false negatives) |Missed +license violations create legal exposure +|=== + +=== Recommended Prover + +*Idris2* — Create `+src/abi/+` with SPDX expression grammar proofs +(completeness and soundness). License family classification could use +algebraic data types with exhaustive matching. + +=== Priority + +*LOW* — License parsing and auditing tool. The 18 unwrap() calls should +be addressed, but the overall risk is limited to incorrect license +reports. diff --git a/PROOF-NEEDS.md b/PROOF-NEEDS.md deleted file mode 100644 index b14b55b..0000000 --- a/PROOF-NEEDS.md +++ /dev/null @@ -1,29 +0,0 @@ - -# PROOF-NEEDS.md — palimpsest-plasma - -## Current State - -- **src/abi/*.idr**: NO -- **Dangerous patterns**: 18 `unwrap()` in Rust code -- **LOC**: ~6,900 (Rust) -- **ABI layer**: Missing - -## What Needs Proving - -| Component | What | Why | -|-----------|------|-----| -| SPDX parser correctness | Parser accepts all valid SPDX expressions and rejects invalid ones | Wrong SPDX parsing causes license misidentification | -| License family registry | Family classification is complete and consistent | Misclassified licenses create compliance risk | -| Union policy parser | Policy composition preserves individual license requirements | Composed policies must not lose restrictions | -| Content audit | Audit detection is sound (no false negatives) | Missed license violations create legal exposure | - -## Recommended Prover - -**Idris2** — Create `src/abi/` with SPDX expression grammar proofs (completeness and soundness). License family classification could use algebraic data types with exhaustive matching. - -## Priority - -**LOW** — License parsing and auditing tool. The 18 unwrap() calls should be addressed, but the overall risk is limited to incorrect license reports. diff --git a/SECURITY.adoc b/SECURITY.adoc new file mode 100644 index 0000000..6f492db --- /dev/null +++ b/SECURITY.adoc @@ -0,0 +1,438 @@ +== Security Policy + +We take security seriously. We appreciate your efforts to responsibly +disclose vulnerabilities and will make every effort to acknowledge your +contributions. + +=== Table of Contents + +* link:#reporting-a-vulnerability[Reporting a Vulnerability] +* link:#what-to-include[What to Include] +* link:#response-timeline[Response Timeline] +* link:#disclosure-policy[Disclosure Policy] +* link:#scope[Scope] +* link:#safe-harbour[Safe Harbour] +* link:#recognition[Recognition] +* link:#security-updates[Security Updates] +* link:#security-best-practices[Security Best Practices] + +''''' + +=== Reporting a Vulnerability + +==== Preferred Method: GitHub Security Advisories + +The preferred method for reporting security vulnerabilities is through +GitHub’s Security Advisory feature: + +[arabic] +. Navigate to +https://github.com/hyperpolymath/palimpsest-plasma/security/advisories/new[Report +a Vulnerability] +. Click *"`Report a vulnerability`"* +. Complete the form with as much detail as possible +. Submit — we’ll receive a private notification + +This method ensures: + +* End-to-end encryption of your report +* Private discussion space for collaboration +* Coordinated disclosure tooling +* Automatic credit when the advisory is published + +==== Alternative: Encrypted Email + +If you cannot use GitHub Security Advisories, you may email us directly: + +[cols=",",] +|=== +|*Email* |6759885+hyperpolymath@users.noreply.github.com +|*Fingerprint* |`+[PGP fingerprint not set]+` +|=== + +____ +*⚠️ Important:* Do not report security vulnerabilities through public +GitHub issues, pull requests, discussions, or social media. +____ + +''''' + +=== What to Include + +A good vulnerability report helps us understand and reproduce the issue +quickly. + +==== Required Information + +* *Description*: Clear explanation of the vulnerability +* *Impact*: What an attacker could achieve (confidentiality, integrity, +availability) +* *Affected versions*: Which versions/commits are affected +* *Reproduction steps*: Detailed steps to reproduce the issue + +==== Helpful Additional Information + +* *Proof of concept*: Code, scripts, or screenshots demonstrating the +vulnerability +* *Attack scenario*: Realistic attack scenario showing exploitability +* *CVSS score*: Your assessment of severity (use +https://www.first.org/cvss/calculator/3.1[CVSS 3.1 Calculator]) +* *CWE ID*: Common Weakness Enumeration identifier if known +* *Suggested fix*: If you have ideas for remediation +* *References*: Links to related vulnerabilities, research, or +advisories + +==== Example Report Structure + +[source,markdown] +---- +## Summary +[One-sentence description of the vulnerability] + +## Vulnerability Type +[e.g., SQL Injection, XSS, SSRF, Path Traversal, etc.] + +## Affected Component +[File path, function name, API endpoint, etc.] + +## Affected Versions +[Version range or specific commits] + +## Severity Assessment +- CVSS 3.1 Score: [X.X] +- CVSS Vector: [CVSS:3.1/AV:X/AC:X/PR:X/UI:X/S:X/C:X/I:X/A:X] + +## Description +[Detailed technical description] + +## Steps to Reproduce +1. [First step] +2. [Second step] +3. [...] + +## Proof of Concept +[Code, curl commands, screenshots, etc.] + +## Impact +[What can an attacker achieve?] + +## Suggested Remediation +[Optional: your ideas for fixing] + +## References +[Links to related issues, CVEs, research] +---- + +''''' + +=== Response Timeline + +We commit to the following response times: + +[width="100%",cols="24%,35%,41%",options="header",] +|=== +|Stage |Timeframe |Description +|*Initial Response* |48 hours |We acknowledge receipt and confirm we’re +investigating + +|*Triage* |7 days |We assess severity, confirm the vulnerability, and +estimate timeline + +|*Status Update* |Every 7 days |Regular updates on remediation progress + +|*Resolution* |90 days |Target for fix development and release (complex +issues may take longer) + +|*Disclosure* |90 days |Public disclosure after fix is available +(coordinated with you) +|=== + +____ +*Note:* These are targets, not guarantees. Complex vulnerabilities may +require more time. We’ll communicate openly about any delays. +____ + +''''' + +=== Disclosure Policy + +We follow *coordinated disclosure* (also known as responsible +disclosure): + +[arabic] +. *You report* the vulnerability privately +. *We acknowledge* and begin investigation +. *We develop* a fix and prepare a release +. *We coordinate* disclosure timing with you +. *We publish* security advisory and fix simultaneously +. *You may publish* your research after disclosure + +==== Our Commitments + +* We will not take legal action against researchers who follow this +policy +* We will work with you to understand and resolve the issue +* We will credit you in the security advisory (unless you prefer +anonymity) +* We will notify you before public disclosure +* We will publish advisories with sufficient detail for users to assess +risk + +==== Your Commitments + +* Report vulnerabilities promptly after discovery +* Give us reasonable time to address the issue before disclosure +* Do not access, modify, or delete data beyond what’s necessary to +demonstrate the vulnerability +* Do not degrade service availability (no DoS testing on production) +* Do not share vulnerability details with others until coordinated +disclosure + +==== Disclosure Timeline + +.... +Day 0 You report vulnerability +Day 1-2 We acknowledge receipt +Day 7 We confirm vulnerability and share initial assessment +Day 7-90 We develop and test fix +Day 90 Coordinated public disclosure + (earlier if fix is ready; later by mutual agreement) +.... + +If we cannot reach agreement on disclosure timing, we default to 90 days +from your initial report. + +''''' + +=== Scope + +==== In Scope ✅ + +The following are within scope for security research: + +* This repository (`+hyperpolymath/palimpsest-plasma+`) and all its code +* Official releases and packages published from this repository +* Documentation that could lead to security issues +* Build and deployment configurations in this repository +* Dependencies (report here, we’ll coordinate with upstream) + +==== Out of Scope ❌ + +The following are *not* in scope: + +* Third-party services we integrate with (report directly to them) +* Social engineering attacks against maintainers +* Physical security +* Denial of service attacks against production infrastructure +* Spam, phishing, or other non-technical attacks +* Issues already reported or publicly known +* Theoretical vulnerabilities without proof of concept + +==== Qualifying Vulnerabilities + +We’re particularly interested in: + +* Remote code execution +* SQL injection, command injection, code injection +* Authentication/authorisation bypass +* Cross-site scripting (XSS) and cross-site request forgery (CSRF) +* Server-side request forgery (SSRF) +* Path traversal / local file inclusion +* Information disclosure (credentials, PII, secrets) +* Cryptographic weaknesses +* Deserialisation vulnerabilities +* Memory safety issues (buffer overflows, use-after-free, etc.) +* Supply chain vulnerabilities (dependency confusion, etc.) +* Significant logic flaws + +==== Non-Qualifying Issues + +The following generally do not qualify as security vulnerabilities: + +* Missing security headers on non-sensitive pages +* Clickjacking on pages without sensitive actions +* Self-XSS (requires victim to paste code) +* Missing rate limiting (unless it enables a specific attack) +* Username/email enumeration (unless high-risk context) +* Missing cookie flags on non-sensitive cookies +* Software version disclosure +* Verbose error messages (unless exposing secrets) +* Best practice deviations without demonstrable impact + +''''' + +=== Safe Harbour + +We support security research conducted in good faith. + +==== Our Promise + +If you conduct security research in accordance with this policy: + +* ✅ We will not initiate legal action against you +* ✅ We will not report your activity to law enforcement +* ✅ We will work with you in good faith to resolve issues +* ✅ We consider your research authorised under the Computer Fraud and +Abuse Act (CFAA), UK Computer Misuse Act, and similar laws +* ✅ We waive any potential claim against you for circumvention of +security controls + +==== Good Faith Requirements + +To qualify for safe harbour, you must: + +* Comply with this security policy +* Report vulnerabilities promptly +* Avoid privacy violations (do not access others’ data) +* Avoid service degradation (no destructive testing) +* Not exploit vulnerabilities beyond proof-of-concept +* Not use vulnerabilities for profit (beyond bug bounties where offered) + +____ +*⚠️ Important:* This safe harbour does not extend to third-party +systems. Always check their policies before testing. +____ + +''''' + +=== Recognition + +We believe in recognising security researchers who help us improve. + +==== Hall of Fame + +Researchers who report valid vulnerabilities will be acknowledged in our +link:SECURITY-ACKNOWLEDGMENTS.md[Security Acknowledgments] (unless they +prefer anonymity). + +Recognition includes: + +* Your name (or chosen alias) +* Link to your website/profile (optional) +* Brief description of the vulnerability class +* Date of report + +==== What We Offer + +* ✅ Public credit in security advisories +* ✅ Acknowledgment in release notes +* ✅ Entry in our Hall of Fame +* ✅ Reference/recommendation letter upon request (for significant +findings) + +==== What We Don’t Currently Offer + +* ❌ Monetary bug bounties +* ❌ Hardware or swag +* ❌ Paid security research contracts + +____ +*Note:* We’re a community project with limited resources. Your +contributions help everyone who uses this software. +____ + +''''' + +=== Security Updates + +==== Receiving Updates + +To stay informed about security updates: + +* *Watch this repository*: Click "`Watch`" → "`Custom`" → Select +"`Security alerts`" +* *GitHub Security Advisories*: Published at +https://github.com/hyperpolymath/palimpsest-plasma/security/advisories[Security +Advisories] +* *Release notes*: Security fixes noted in link:CHANGELOG.md[CHANGELOG] + +==== Update Policy + +[cols=",",options="header",] +|=== +|Severity |Response +|*Critical/High* |Patch release as soon as fix is ready +|*Medium* |Included in next scheduled release (or earlier) +|*Low* |Included in next scheduled release +|=== + +==== Supported Versions + +[cols=",,",options="header",] +|=== +|Version |Supported |Notes +|`+main+` branch |✅ Yes |Latest development +|Latest release |✅ Yes |Current stable +|Previous minor release |✅ Yes |Security fixes backported +|Older versions |❌ No |Please upgrade +|=== + +''''' + +=== Security Best Practices + +When using Palimpsest Plasma, we recommend: + +==== General + +* Keep dependencies up to date +* Use the latest stable release +* Subscribe to security notifications +* Review configuration against security documentation +* Follow principle of least privilege + +==== For Contributors + +* Never commit secrets, credentials, or API keys +* Use signed commits (`+git config commit.gpgsign true+`) +* Review dependencies before adding them +* Run security linters locally before pushing +* Report any concerns about existing code + +''''' + +=== Additional Resources + +* https://github.com/hyperpolymath/palimpsest-plasma/security/advisories[Security +Advisories] +* link:CHANGELOG.md[Changelog] +* link:CONTRIBUTING.md[Contributing Guidelines] +* https://cve.mitre.org/[CVE Database] +* https://www.first.org/cvss/calculator/3.1[CVSS Calculator] + +''''' + +=== Contact + +[width="100%",cols="50%,50%",options="header",] +|=== +|Purpose |Contact +|*Security issues* +|https://github.com/hyperpolymath/palimpsest-plasma/security/advisories/new[Report +via GitHub] or 6759885+hyperpolymath@users.noreply.github.com + +|*General questions* +|https://github.com/hyperpolymath/palimpsest-plasma/discussions[GitHub +Discussions] + +|*Other enquiries* |See link:README.md[README] for contact information +|=== + +''''' + +=== Policy Changes + +This security policy may be updated from time to time. Significant +changes will be: + +* Committed to this repository with a clear commit message +* Noted in the changelog +* Announced via GitHub Discussions (for major changes) + +''''' + +_Thank you for helping keep Palimpsest Plasma and its users safe._ 🛡️ + +''''' + +Last updated: 2026 · Policy version: 1.0.0 diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 4f745fa..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,380 +0,0 @@ - -# Security Policy - -We take security seriously. We appreciate your efforts to responsibly disclose vulnerabilities and will make every effort to acknowledge your contributions. - -## Table of Contents - -- [Reporting a Vulnerability](#reporting-a-vulnerability) -- [What to Include](#what-to-include) -- [Response Timeline](#response-timeline) -- [Disclosure Policy](#disclosure-policy) -- [Scope](#scope) -- [Safe Harbour](#safe-harbour) -- [Recognition](#recognition) -- [Security Updates](#security-updates) -- [Security Best Practices](#security-best-practices) - ---- - -## Reporting a Vulnerability - -### Preferred Method: GitHub Security Advisories - -The preferred method for reporting security vulnerabilities is through GitHub's Security Advisory feature: - -1. Navigate to [Report a Vulnerability](https://github.com/hyperpolymath/palimpsest-plasma/security/advisories/new) -2. Click **"Report a vulnerability"** -3. Complete the form with as much detail as possible -4. Submit — we'll receive a private notification - -This method ensures: - -- End-to-end encryption of your report -- Private discussion space for collaboration -- Coordinated disclosure tooling -- Automatic credit when the advisory is published - -### Alternative: Encrypted Email - -If you cannot use GitHub Security Advisories, you may email us directly: - -| | | -|---|---| -| **Email** | 6759885+hyperpolymath@users.noreply.github.com | -| **Fingerprint** | `[PGP fingerprint not set]` | - - -> **⚠️ Important:** Do not report security vulnerabilities through public GitHub issues, pull requests, discussions, or social media. - ---- - -## What to Include - -A good vulnerability report helps us understand and reproduce the issue quickly. - -### Required Information - -- **Description**: Clear explanation of the vulnerability -- **Impact**: What an attacker could achieve (confidentiality, integrity, availability) -- **Affected versions**: Which versions/commits are affected -- **Reproduction steps**: Detailed steps to reproduce the issue - -### Helpful Additional Information - -- **Proof of concept**: Code, scripts, or screenshots demonstrating the vulnerability -- **Attack scenario**: Realistic attack scenario showing exploitability -- **CVSS score**: Your assessment of severity (use [CVSS 3.1 Calculator](https://www.first.org/cvss/calculator/3.1)) -- **CWE ID**: Common Weakness Enumeration identifier if known -- **Suggested fix**: If you have ideas for remediation -- **References**: Links to related vulnerabilities, research, or advisories - -### Example Report Structure - -```markdown -## Summary -[One-sentence description of the vulnerability] - -## Vulnerability Type -[e.g., SQL Injection, XSS, SSRF, Path Traversal, etc.] - -## Affected Component -[File path, function name, API endpoint, etc.] - -## Affected Versions -[Version range or specific commits] - -## Severity Assessment -- CVSS 3.1 Score: [X.X] -- CVSS Vector: [CVSS:3.1/AV:X/AC:X/PR:X/UI:X/S:X/C:X/I:X/A:X] - -## Description -[Detailed technical description] - -## Steps to Reproduce -1. [First step] -2. [Second step] -3. [...] - -## Proof of Concept -[Code, curl commands, screenshots, etc.] - -## Impact -[What can an attacker achieve?] - -## Suggested Remediation -[Optional: your ideas for fixing] - -## References -[Links to related issues, CVEs, research] -``` - ---- - -## Response Timeline - -We commit to the following response times: - -| Stage | Timeframe | Description | -|-------|-----------|-------------| -| **Initial Response** | 48 hours | We acknowledge receipt and confirm we're investigating | -| **Triage** | 7 days | We assess severity, confirm the vulnerability, and estimate timeline | -| **Status Update** | Every 7 days | Regular updates on remediation progress | -| **Resolution** | 90 days | Target for fix development and release (complex issues may take longer) | -| **Disclosure** | 90 days | Public disclosure after fix is available (coordinated with you) | - -> **Note:** These are targets, not guarantees. Complex vulnerabilities may require more time. We'll communicate openly about any delays. - ---- - -## Disclosure Policy - -We follow **coordinated disclosure** (also known as responsible disclosure): - -1. **You report** the vulnerability privately -2. **We acknowledge** and begin investigation -3. **We develop** a fix and prepare a release -4. **We coordinate** disclosure timing with you -5. **We publish** security advisory and fix simultaneously -6. **You may publish** your research after disclosure - -### Our Commitments - -- We will not take legal action against researchers who follow this policy -- We will work with you to understand and resolve the issue -- We will credit you in the security advisory (unless you prefer anonymity) -- We will notify you before public disclosure -- We will publish advisories with sufficient detail for users to assess risk - -### Your Commitments - -- Report vulnerabilities promptly after discovery -- Give us reasonable time to address the issue before disclosure -- Do not access, modify, or delete data beyond what's necessary to demonstrate the vulnerability -- Do not degrade service availability (no DoS testing on production) -- Do not share vulnerability details with others until coordinated disclosure - -### Disclosure Timeline - -``` -Day 0 You report vulnerability -Day 1-2 We acknowledge receipt -Day 7 We confirm vulnerability and share initial assessment -Day 7-90 We develop and test fix -Day 90 Coordinated public disclosure - (earlier if fix is ready; later by mutual agreement) -``` - -If we cannot reach agreement on disclosure timing, we default to 90 days from your initial report. - ---- - -## Scope - -### In Scope ✅ - -The following are within scope for security research: - -- This repository (`hyperpolymath/palimpsest-plasma`) and all its code -- Official releases and packages published from this repository -- Documentation that could lead to security issues -- Build and deployment configurations in this repository -- Dependencies (report here, we'll coordinate with upstream) - -### Out of Scope ❌ - -The following are **not** in scope: - -- Third-party services we integrate with (report directly to them) -- Social engineering attacks against maintainers -- Physical security -- Denial of service attacks against production infrastructure -- Spam, phishing, or other non-technical attacks -- Issues already reported or publicly known -- Theoretical vulnerabilities without proof of concept - -### Qualifying Vulnerabilities - -We're particularly interested in: - -- Remote code execution -- SQL injection, command injection, code injection -- Authentication/authorisation bypass -- Cross-site scripting (XSS) and cross-site request forgery (CSRF) -- Server-side request forgery (SSRF) -- Path traversal / local file inclusion -- Information disclosure (credentials, PII, secrets) -- Cryptographic weaknesses -- Deserialisation vulnerabilities -- Memory safety issues (buffer overflows, use-after-free, etc.) -- Supply chain vulnerabilities (dependency confusion, etc.) -- Significant logic flaws - -### Non-Qualifying Issues - -The following generally do not qualify as security vulnerabilities: - -- Missing security headers on non-sensitive pages -- Clickjacking on pages without sensitive actions -- Self-XSS (requires victim to paste code) -- Missing rate limiting (unless it enables a specific attack) -- Username/email enumeration (unless high-risk context) -- Missing cookie flags on non-sensitive cookies -- Software version disclosure -- Verbose error messages (unless exposing secrets) -- Best practice deviations without demonstrable impact - ---- - -## Safe Harbour - -We support security research conducted in good faith. - -### Our Promise - -If you conduct security research in accordance with this policy: - -- ✅ We will not initiate legal action against you -- ✅ We will not report your activity to law enforcement -- ✅ We will work with you in good faith to resolve issues -- ✅ We consider your research authorised under the Computer Fraud and Abuse Act (CFAA), UK Computer Misuse Act, and similar laws -- ✅ We waive any potential claim against you for circumvention of security controls - -### Good Faith Requirements - -To qualify for safe harbour, you must: - -- Comply with this security policy -- Report vulnerabilities promptly -- Avoid privacy violations (do not access others' data) -- Avoid service degradation (no destructive testing) -- Not exploit vulnerabilities beyond proof-of-concept -- Not use vulnerabilities for profit (beyond bug bounties where offered) - -> **⚠️ Important:** This safe harbour does not extend to third-party systems. Always check their policies before testing. - ---- - -## Recognition - -We believe in recognising security researchers who help us improve. - -### Hall of Fame - -Researchers who report valid vulnerabilities will be acknowledged in our [Security Acknowledgments](SECURITY-ACKNOWLEDGMENTS.md) (unless they prefer anonymity). - -Recognition includes: - -- Your name (or chosen alias) -- Link to your website/profile (optional) -- Brief description of the vulnerability class -- Date of report - -### What We Offer - -- ✅ Public credit in security advisories -- ✅ Acknowledgment in release notes -- ✅ Entry in our Hall of Fame -- ✅ Reference/recommendation letter upon request (for significant findings) - -### What We Don't Currently Offer - -- ❌ Monetary bug bounties -- ❌ Hardware or swag -- ❌ Paid security research contracts - -> **Note:** We're a community project with limited resources. Your contributions help everyone who uses this software. - ---- - -## Security Updates - -### Receiving Updates - -To stay informed about security updates: - -- **Watch this repository**: Click "Watch" → "Custom" → Select "Security alerts" -- **GitHub Security Advisories**: Published at [Security Advisories](https://github.com/hyperpolymath/palimpsest-plasma/security/advisories) -- **Release notes**: Security fixes noted in [CHANGELOG](CHANGELOG.md) - -### Update Policy - -| Severity | Response | -|----------|----------| -| **Critical/High** | Patch release as soon as fix is ready | -| **Medium** | Included in next scheduled release (or earlier) | -| **Low** | Included in next scheduled release | - -### Supported Versions - - - -| Version | Supported | Notes | -|---------|-----------|-------| -| `main` branch | ✅ Yes | Latest development | -| Latest release | ✅ Yes | Current stable | -| Previous minor release | ✅ Yes | Security fixes backported | -| Older versions | ❌ No | Please upgrade | - ---- - -## Security Best Practices - -When using Palimpsest Plasma, we recommend: - -### General - -- Keep dependencies up to date -- Use the latest stable release -- Subscribe to security notifications -- Review configuration against security documentation -- Follow principle of least privilege - -### For Contributors - -- Never commit secrets, credentials, or API keys -- Use signed commits (`git config commit.gpgsign true`) -- Review dependencies before adding them -- Run security linters locally before pushing -- Report any concerns about existing code - ---- - -## Additional Resources - -- [Security Advisories](https://github.com/hyperpolymath/palimpsest-plasma/security/advisories) -- [Changelog](CHANGELOG.md) -- [Contributing Guidelines](CONTRIBUTING.md) -- [CVE Database](https://cve.mitre.org/) -- [CVSS Calculator](https://www.first.org/cvss/calculator/3.1) - ---- - -## Contact - -| Purpose | Contact | -|---------|---------| -| **Security issues** | [Report via GitHub](https://github.com/hyperpolymath/palimpsest-plasma/security/advisories/new) or 6759885+hyperpolymath@users.noreply.github.com | -| **General questions** | [GitHub Discussions](https://github.com/hyperpolymath/palimpsest-plasma/discussions) | -| **Other enquiries** | See [README](README.md) for contact information | - ---- - -## Policy Changes - -This security policy may be updated from time to time. Significant changes will be: - -- Committed to this repository with a clear commit message -- Noted in the changelog -- Announced via GitHub Discussions (for major changes) - ---- - -*Thank you for helping keep Palimpsest Plasma and its users safe.* 🛡️ - ---- - -Last updated: 2026 · Policy version: 1.0.0 diff --git a/TEST-NEEDS.adoc b/TEST-NEEDS.adoc new file mode 100644 index 0000000..3f966ea --- /dev/null +++ b/TEST-NEEDS.adoc @@ -0,0 +1,74 @@ +== TEST-NEEDS.md — palimpsest-plasma + +____ +Updated 2026-07-02 (v0.2.0). The 2026-03-29 audit ("`zero unit tests`") +described the pre-engine repo and is superseded. +____ + +=== Current State + +[width="100%",cols="50%,25%,25%",options="header",] +|=== +|Category |Count |Notes +|Unit tests |61 |Inline `+#[test]+` across plasma-parser (42) and +plasma-engine (19) + +|Integration |4 |`+tests/check_selftest.rs+` — the repo checks itself +with its own bundled policy + +|E2E |1 |`+check_self_passes+` runs the built binary end-to-end + +|Determinism |2 |Byte-identical JSON asserted at unit and binary level + +|Benchmarks |0 |None yet +|=== + +Run everything with `+cargo test --workspace+`. + +=== What’s Covered + +* SPDX expression parsing (lexer, parser, catalog +incl. Palimpsest-family ids) +* Zone assignment and `+.plasma.toml+` parsing +* Repository scanning (`+scan_repo+`): counts, score, deterministic +ordering +* Policy schema loading: version gating, duplicate rule ids, +reserved-construct rejection, TOML↔JSON round-trip +* Evaluation semantics: deontic matrix rows, condition gating, subject +expansion, overlay provenance, permission never violating +* SARIF shape: rule namespace, levels, location omission for repo +subjects +* Fact collection: skip list, header extraction, Cargo version metadata + +=== What’s Missing + +==== Property-Based Tests + +* [ ] Arbitrary policy documents: load → serialize → reload identity +* [ ] Arbitrary fact sets: evaluation totality (no panics) under fuzzing +* [ ] SPDX parser: arbitrary expression round-trips + +==== E2E Tests + +* [ ] `+plasma init+`/`+migrate+` against fixture repos (tempdir +round-trips) +* [ ] `+plasma audit --fix+` idempotence (fixing twice changes nothing) +* [ ] `+plasma check --policy +` (JSON policy path is unit-tested +only) + +==== Aspect Tests + +* *Security:* path traversal attempts in audit/fact walking; SVG/badge +output injection +* *Performance:* scan/evaluate time vs repository size benchmarks +* *Error handling:* malformed policy files produce the intended +`+SchemaError+` variants (partially covered) + +=== FAKE-FUZZ ALERT (still open) + +* `+tests/fuzz/placeholder.txt+` is a scorecard placeholder inherited +from rsr-template-repo — it does NOT provide real fuzz testing +* Replace with an actual fuzz harness (`+cargo-fuzz+` over +`+load_policy_str+` and `+parse_spdx_expr+` are the natural first +targets) or remove the file +* Priority: P2 — creates false impression of fuzz coverage diff --git a/TEST-NEEDS.md b/TEST-NEEDS.md deleted file mode 100644 index f719463..0000000 --- a/TEST-NEEDS.md +++ /dev/null @@ -1,59 +0,0 @@ - -# TEST-NEEDS.md — palimpsest-plasma - -> Updated 2026-07-02 (v0.2.0). The 2026-03-29 audit ("zero unit tests") -> described the pre-engine repo and is superseded. - -## Current State - -| Category | Count | Notes | -|--------------|-------|-------| -| Unit tests | 61 | Inline `#[test]` across plasma-parser (42) and plasma-engine (19) | -| Integration | 4 | `tests/check_selftest.rs` — the repo checks itself with its own bundled policy | -| E2E | 1 | `check_self_passes` runs the built binary end-to-end | -| Determinism | 2 | Byte-identical JSON asserted at unit and binary level | -| Benchmarks | 0 | None yet | - -Run everything with `cargo test --workspace`. - -## What's Covered - -- SPDX expression parsing (lexer, parser, catalog incl. Palimpsest-family ids) -- Zone assignment and `.plasma.toml` parsing -- Repository scanning (`scan_repo`): counts, score, deterministic ordering -- Policy schema loading: version gating, duplicate rule ids, reserved-construct - rejection, TOML↔JSON round-trip -- Evaluation semantics: deontic matrix rows, condition gating, subject - expansion, overlay provenance, permission never violating -- SARIF shape: rule namespace, levels, location omission for repo subjects -- Fact collection: skip list, header extraction, Cargo version metadata - -## What's Missing - -### Property-Based Tests -- [ ] Arbitrary policy documents: load → serialize → reload identity -- [ ] Arbitrary fact sets: evaluation totality (no panics) under fuzzing -- [ ] SPDX parser: arbitrary expression round-trips - -### E2E Tests -- [ ] `plasma init`/`migrate` against fixture repos (tempdir round-trips) -- [ ] `plasma audit --fix` idempotence (fixing twice changes nothing) -- [ ] `plasma check --policy ` (JSON policy path is unit-tested only) - -### Aspect Tests -- **Security:** path traversal attempts in audit/fact walking; SVG/badge - output injection -- **Performance:** scan/evaluate time vs repository size benchmarks -- **Error handling:** malformed policy files produce the intended - `SchemaError` variants (partially covered) - -## FAKE-FUZZ ALERT (still open) - -- `tests/fuzz/placeholder.txt` is a scorecard placeholder inherited from - rsr-template-repo — it does NOT provide real fuzz testing -- Replace with an actual fuzz harness (`cargo-fuzz` over `load_policy_str` - and `parse_spdx_expr` are the natural first targets) or remove the file -- Priority: P2 — creates false impression of fuzz coverage diff --git a/TOPOLOGY.md b/TOPOLOGY.adoc similarity index 87% rename from TOPOLOGY.md rename to TOPOLOGY.adoc index b50acf7..43fbd45 100644 --- a/TOPOLOGY.md +++ b/TOPOLOGY.adoc @@ -1,15 +1,8 @@ - - - +== Palimpsest Plasma — Project Topology -# Palimpsest Plasma — Project Topology +=== System Architecture -## System Architecture - -``` +.... ┌─────────────────────────────────────────────────────┐ │ plasma (CLI) │ │ check · facts · policy · audit · init · badge · │ @@ -39,11 +32,11 @@ Copyright (c) Jonathan D.A. Jewell │ Contract: JSON findings · SARIF plasma/ · │ │ plasma facts snapshots (diffable) │ └──────────────────────────────────────────────────────────────┘ -``` +.... -## Completion Dashboard +=== Completion Dashboard -``` +.... COMPONENT STATUS NOTES ───────────────────────────────── ────────────────── ───────────────────────────────── PLASMA-PARSER (Rust) @@ -77,29 +70,30 @@ INFRASTRUCTURE ───────────────────────────────────────────────────────────────────────────── OVERALL: █████░░░░░ ~50% Engine v0 shipped; planner + surfaces ahead -``` +.... -## Key Dependencies +=== Key Dependencies -``` +.... Policy AST ──► Schema Loader ──► Pure Evaluator ──► Findings ──► human/JSON/SARIF ▲ Fact Collector (walk, SPDX headers, ──┘ metadata, git) ── uses plasma-parser header extraction plasma audit ──► plasma-parser scan_repo ──► zone map (.plasma.toml) -``` +.... -## Update Protocol +=== Update Protocol This file is maintained by both humans and AI agents. When updating: -1. **After completing a component**: Change its bar and percentage -2. **After adding a component**: Add a new row in the appropriate section -3. **After architectural changes**: Update the ASCII diagram -4. **Date**: Update the `Last updated` comment at the top of this file +[arabic] +. *After completing a component*: Change its bar and percentage +. *After adding a component*: Add a new row in the appropriate section +. *After architectural changes*: Update the ASCII diagram +. *Date*: Update the `+Last updated+` comment at the top of this file -Progress bars use: `█` (filled) and `░` (empty), 10 characters wide. -Percentages: 0%, 10%, 20%, ... 100% (in 10% increments). -Honesty rule: a component that does not compile or run is 0–20%, -whatever its design documents say. +Progress bars use: `+█+` (filled) and `+░+` (empty), 10 characters wide. +Percentages: 0%, 10%, 20%, … 100% (in 10% increments). Honesty rule: a +component that does not compile or run is 0–20%, whatever its design +documents say. diff --git a/docs/tech-debt-2026-05-26.adoc b/docs/tech-debt-2026-05-26.adoc new file mode 100644 index 0000000..4aaf69d --- /dev/null +++ b/docs/tech-debt-2026-05-26.adoc @@ -0,0 +1,79 @@ +== Tech-Debt Audit — palimpsest-plasma — 2026-05-26 + +____ +*Update 2026-07-02 (v0.2.0):* the licence-drift finding below +(`+PMPL-1.0-or-later+` vs `+PPMPL-1.0-or-later+` vs manifest) is +resolved — the project unified on MPL-2.0 (code) / CC-BY-SA-4.0 (docs) +and swept all SPDX headers. This file is kept as the original +point-in-time record. +____ + +*Source:* estate-wide automated scan 2026-05-26. *Companion:* +https://github.com/hyperpolymath/standards/tree/main/docs/audits[`+hyperpolymath/standards+` +2026-05-26-estate-*-debt audits]. *Combined severity:* `+LOW+`. + +This file records the _raw findings_ — it does not by itself fix the +debt. Each section ends with a '`Recommended next move`' line; closing +the debt is follow-up work. + +=== 1. Proof debt + +No proof-bearing files (`+*.v+`, `+*.lean+`, `+*.agda+`, `+*.idr+`, +`+*.idr2+`, `+*.fst+`, `+*.dfy+`, `+*.tla+`, `+*.ads+`, `+*.adb+`) found +in this repo. + +*Recommended next move:* none. + +=== 2. Licence debt + +[cols=",",options="header",] +|=== +|Field |Value +|LICENSE file |`+LICENSE+` +|SPDX header |`+PMPL-1.0-or-later+` +|Manifest licence |`+PPMPL-1.0-or-later+` +|Body classifier |`+PMPL-1.0-or-later+` +|Severity |`+ok+` +|=== + +*Recommended next move:* none for licence. + +=== 3. Documentation debt + +[cols=",",options="header",] +|=== +|Field |Value +|README lines |113 +|`+docs/+` files |9 +|`+docs/+` LoC |2046 +|CHANGELOG.md |N +|CONTRIBUTING.md |Y +|CODE_OF_CONDUCT.md |Y +|SECURITY.md |Y +|Severity |`+LOW+` +|=== + +*Recommended next move:* `+docs/+` has only 9 file(s). Aim for ≥10 +organised docs (architecture, usage, contributing-guide, +troubleshooting, design-decisions). The user’s bar for a +"`heavily-developed and well-organised wiki`" is ≥10 files with topical +organisation. + +Additionally: *CHANGELOG.md is missing.* 65% of estate repos lack one — +adopting a CHANGELOG (or auto-generating via `+git-cliff+`) is a +recommended estate-wide follow-up. + +=== Cross-references + +* Estate proof-debt audit: +`+hyperpolymath/standards/docs/audits/2026-05-26-estate-proof-debt.md+` +* Estate licence-debt audit: +`+hyperpolymath/standards/docs/audits/2026-05-26-estate-licence-debt.md+` +* Estate documentation-debt audit: +`+hyperpolymath/standards/docs/audits/2026-05-26-estate-documentation-debt.md+` + +''''' + +🤖 Generated by Claude Code estate-wide tech-debt scan (2026-05-26). +This file is informational — closing the debt is follow-up work owned by +the maintainer. diff --git a/docs/tech-debt-2026-05-26.md b/docs/tech-debt-2026-05-26.md deleted file mode 100644 index c92b179..0000000 --- a/docs/tech-debt-2026-05-26.md +++ /dev/null @@ -1,61 +0,0 @@ - -# Tech-Debt Audit — palimpsest-plasma — 2026-05-26 - -> **Update 2026-07-02 (v0.2.0):** the licence-drift finding below -> (`PMPL-1.0-or-later` vs `PPMPL-1.0-or-later` vs manifest) is resolved — -> the project unified on MPL-2.0 (code) / CC-BY-SA-4.0 (docs) and swept all -> SPDX headers. This file is kept as the original point-in-time record. - -**Source:** estate-wide automated scan 2026-05-26. -**Companion:** [`hyperpolymath/standards` 2026-05-26-estate-*-debt audits](https://github.com/hyperpolymath/standards/tree/main/docs/audits). -**Combined severity:** `LOW`. - -This file records the *raw findings* — it does not by itself fix the debt. Each section ends with a 'Recommended next move' line; closing the debt is follow-up work. - -## 1. Proof debt - -No proof-bearing files (`*.v`, `*.lean`, `*.agda`, `*.idr`, `*.idr2`, `*.fst`, `*.dfy`, `*.tla`, `*.ads`, `*.adb`) found in this repo. - -**Recommended next move:** none. - -## 2. Licence debt - -| Field | Value | -|---|---| -| LICENSE file | `LICENSE` | -| SPDX header | `PMPL-1.0-or-later` | -| Manifest licence | `PPMPL-1.0-or-later` | -| Body classifier | `PMPL-1.0-or-later` | -| Severity | `ok` | - -**Recommended next move:** none for licence. - -## 3. Documentation debt - -| Field | Value | -|---|---| -| README lines | 113 | -| `docs/` files | 9 | -| `docs/` LoC | 2046 | -| CHANGELOG.md | N | -| CONTRIBUTING.md | Y | -| CODE_OF_CONDUCT.md | Y | -| SECURITY.md | Y | -| Severity | `LOW` | - -**Recommended next move:** `docs/` has only 9 file(s). Aim for ≥10 organised docs (architecture, usage, contributing-guide, troubleshooting, design-decisions). The user's bar for a "heavily-developed and well-organised wiki" is ≥10 files with topical organisation. - -Additionally: **CHANGELOG.md is missing.** 65% of estate repos lack one — adopting a CHANGELOG (or auto-generating via `git-cliff`) is a recommended estate-wide follow-up. - -## Cross-references - -- Estate proof-debt audit: `hyperpolymath/standards/docs/audits/2026-05-26-estate-proof-debt.md` -- Estate licence-debt audit: `hyperpolymath/standards/docs/audits/2026-05-26-estate-licence-debt.md` -- Estate documentation-debt audit: `hyperpolymath/standards/docs/audits/2026-05-26-estate-documentation-debt.md` - ---- - -🤖 Generated by Claude Code estate-wide tech-debt scan (2026-05-26). This file is informational — closing the debt is follow-up work owned by the maintainer. diff --git a/llm-warmup-dev.adoc b/llm-warmup-dev.adoc new file mode 100644 index 0000000..1a202a6 --- /dev/null +++ b/llm-warmup-dev.adoc @@ -0,0 +1,19 @@ +== LLM Warmup — palimpsest-plasma (Developer) + +=== What is palimpsest-plasma? + +See README.adoc for overview. + +=== Key Commands + +* `+just setup+` — set up development environment +* `+just build+` — build the project +* `+just test+` — run tests +* `+just doctor+` — diagnose issues +* `+just check+` — run plasma against this repo (dogfood) + +=== Quick Context + +* License: MPL-2.0 (code), CC-BY-SA-4.0 (docs) +* Part of hyperpolymath ecosystem +* See EXPLAINME.adoc for architecture diff --git a/llm-warmup-dev.md b/llm-warmup-dev.md deleted file mode 100644 index ecd3e45..0000000 --- a/llm-warmup-dev.md +++ /dev/null @@ -1,20 +0,0 @@ - -# LLM Warmup — palimpsest-plasma (Developer) - -## What is palimpsest-plasma? -See README.adoc for overview. - -## Key Commands -- `just setup` — set up development environment -- `just build` — build the project -- `just test` — run tests -- `just doctor` — diagnose issues -- `just check` — run plasma against this repo (dogfood) - -## Quick Context -- License: MPL-2.0 (code), CC-BY-SA-4.0 (docs) -- Part of hyperpolymath ecosystem -- See EXPLAINME.adoc for architecture diff --git a/llm-warmup-user.adoc b/llm-warmup-user.adoc new file mode 100644 index 0000000..6c17dc8 --- /dev/null +++ b/llm-warmup-user.adoc @@ -0,0 +1,19 @@ +== LLM Warmup — palimpsest-plasma (User) + +=== What is palimpsest-plasma? + +See README.adoc for overview. + +=== Key Commands + +* `+just setup+` — set up development environment +* `+just build+` — build the project +* `+just test+` — run tests +* `+just doctor+` — diagnose issues +* `+just check+` — run plasma against this repo (dogfood) + +=== Quick Context + +* License: MPL-2.0 (code), CC-BY-SA-4.0 (docs) +* Part of hyperpolymath ecosystem +* See EXPLAINME.adoc for architecture diff --git a/llm-warmup-user.md b/llm-warmup-user.md deleted file mode 100644 index d1b6947..0000000 --- a/llm-warmup-user.md +++ /dev/null @@ -1,20 +0,0 @@ - -# LLM Warmup — palimpsest-plasma (User) - -## What is palimpsest-plasma? -See README.adoc for overview. - -## Key Commands -- `just setup` — set up development environment -- `just build` — build the project -- `just test` — run tests -- `just doctor` — diagnose issues -- `just check` — run plasma against this repo (dogfood) - -## Quick Context -- License: MPL-2.0 (code), CC-BY-SA-4.0 (docs) -- Part of hyperpolymath ecosystem -- See EXPLAINME.adoc for architecture diff --git a/site/content/index.adoc b/site/content/index.adoc new file mode 100644 index 0000000..5682e4c --- /dev/null +++ b/site/content/index.adoc @@ -0,0 +1,36 @@ +== SPDX-License-Identifier: CC-BY-SA-4.0 + +== Copyright (c) Jonathan D.A. Jewell j.d.a.jewell@open.ac.uk + +%\{ title: "`Palimpsest Plasma`", slug: "`index`", description: "`A +deterministic, typed policy engine for the agentic era.`", date: +~D[2026-07-02] } — + +=== Overview + +Palimpsest Plasma is a deterministic, typed *policy engine*. You write +policies as machine-readable deontic rules — obligations, prohibitions, +and permissions over repository state — and `+plasma check+` evaluates a +repository against them with byte-for-byte reproducible results. + +* *Engine:* typed policy AST, versioned TOML/JSON schema, a pure and +total evaluator (`+plasma-engine/+`) +* *License tooling:* SPDX header auditing over a zone-aware license map +(`+plasma-parser/+`) +* *Agent-honesty contract:* JSON findings, SARIF results with stable +`+plasma/+` identifiers, and diffable `+plasma facts+` +snapshots + +=== Quickstart + +.... +cargo build --release +./target/release/plasma check . +./target/release/plasma facts . +.... + +=== Building this site locally + +Install Elixir (1.15+), then from the `+site/+` directory run +`+mix site.build+`. The command regenerates `+site/_site+`, which GitHub +Actions uploads to Pages. diff --git a/site/content/index.md b/site/content/index.md deleted file mode 100644 index d452994..0000000 --- a/site/content/index.md +++ /dev/null @@ -1,36 +0,0 @@ -# SPDX-License-Identifier: CC-BY-SA-4.0 -# Copyright (c) Jonathan D.A. Jewell -%{ - title: "Palimpsest Plasma", - slug: "index", - description: "A deterministic, typed policy engine for the agentic era.", - date: ~D[2026-07-02] -} ---- - -## Overview - -Palimpsest Plasma is a deterministic, typed **policy engine**. You write -policies as machine-readable deontic rules — obligations, prohibitions, and -permissions over repository state — and `plasma check` evaluates a repository -against them with byte-for-byte reproducible results. - -- **Engine:** typed policy AST, versioned TOML/JSON schema, a pure and total - evaluator (`plasma-engine/`) -- **License tooling:** SPDX header auditing over a zone-aware license map - (`plasma-parser/`) -- **Agent-honesty contract:** JSON findings, SARIF results with stable - `plasma/` identifiers, and diffable `plasma facts` snapshots - -## Quickstart - -``` -cargo build --release -./target/release/plasma check . -./target/release/plasma facts . -``` - -## Building this site locally - -Install Elixir (1.15+), then from the `site/` directory run `mix site.build`. -The command regenerates `site/_site`, which GitHub Actions uploads to Pages. diff --git a/site/content/releases.adoc b/site/content/releases.adoc new file mode 100644 index 0000000..ae8b431 --- /dev/null +++ b/site/content/releases.adoc @@ -0,0 +1,30 @@ +== SPDX-License-Identifier: CC-BY-SA-4.0 + +== Copyright (c) Jonathan D.A. Jewell j.d.a.jewell@open.ac.uk + +%\{ title: "`Releases`", slug: "`releases`", description: "`Release +history and how to build from source.`", date: ~D[2026-07-02] } — + +=== v0.2.0 — Engine v0 + +The current release is a deterministic, typed policy engine. See +`+docs/release-notes.adoc+` and `+CHANGELOG.md+` for the full list of +changes. + +Highlights: + +* `+plasma-engine+` — policy AST, versioned schema, pure evaluator +* `+plasma check+` / `+facts+` / `+policy validate+`, plus parser-backed +`+audit+` +* Licensing unified: code MPL-2.0, documentation CC-BY-SA-4.0 + +=== Building from source + +.... +git clone https://github.com/hyperpolymath/palimpsest-plasma.git +cd palimpsest-plasma +cargo build --release +cargo test --workspace +.... + +The binary is `+target/release/plasma+`. diff --git a/site/content/releases.md b/site/content/releases.md deleted file mode 100644 index 57f0669..0000000 --- a/site/content/releases.md +++ /dev/null @@ -1,31 +0,0 @@ -# SPDX-License-Identifier: CC-BY-SA-4.0 -# Copyright (c) Jonathan D.A. Jewell -%{ - title: "Releases", - slug: "releases", - description: "Release history and how to build from source.", - date: ~D[2026-07-02] -} ---- - -## v0.2.0 — Engine v0 - -The current release is a deterministic, typed policy engine. See -`docs/release-notes.adoc` and `CHANGELOG.md` for the full list of changes. - -Highlights: - -* `plasma-engine` — policy AST, versioned schema, pure evaluator -* `plasma check` / `facts` / `policy validate`, plus parser-backed `audit` -* Licensing unified: code MPL-2.0, documentation CC-BY-SA-4.0 - -## Building from source - -``` -git clone https://github.com/hyperpolymath/palimpsest-plasma.git -cd palimpsest-plasma -cargo build --release -cargo test --workspace -``` - -The binary is `target/release/plasma`.