Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
252 changes: 136 additions & 116 deletions ABI-FFI-README.md → ABI-FFI-README.adoc

Large diffs are not rendered by default.

48 changes: 48 additions & 0 deletions ARCHITECTURE.adoc
Original file line number Diff line number Diff line change
@@ -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_
47 changes: 0 additions & 47 deletions ARCHITECTURE.md

This file was deleted.

67 changes: 67 additions & 0 deletions CHANGELOG.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
== Changelog

All notable changes to `+volumod+` 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]

==== Added

* feat(ci): enable Hypatia scanning

==== Fixed

* fix(codeql): switch language matrix to '`actions`' (no JS/TS in repo)
(#37)
* fix(codeql): switch language matrix to '`actions`' (no JS/TS in repo)
(#35)
* fix(licence): clear scaffold-placeholder leak (PLMP sentinel + doubled
suffix) (#32)
* fix(ci): sync hypatia-scan.yml to canonical (kill cd-scanner build
drift) (#27)
* fix(ci): build Hypatia escript from repo root (estate dogfood drift)
* fix(codeql): switch language matrix to '`actions`' (no JS/TS in repo)
(#25)
* fix(ci): Phase-2 fleet submission must not fail the security gate
(#24)
* fix(ci): hypatia-scan workdir ($\{\{ env.HOME }} resolves empty) (#23)
* fix(ci): rsr-antipattern.yml duplicate heredoc (#21)
* fix(codeql): switch language matrix to '`actions`' (no JS/TS in repo)
(#22)

==== Documentation

* docs: record tech-debt audit findings (2026-05-26) (#43)
* docs: integrate research findings and design decisions into project
documentation
* docs: update SCM files with project information
* docs: add SCM checkpoint files
* docs: add checkpoint files for state tracking

==== CI

* build(deps): bump github/codeql-action from 4.35.5 to 4.36.0 (#38)
* build(deps): bump actions/upload-artifact from 4.6.2 to 7.0.1 (#30)
* build(deps): bump actions/github-script from 8.0.0 to 9.0.0 (#29)
* build(deps): bump github/codeql-action from 4.32.6 to 4.35.5 (#28)
* build(deps): bump actions/upload-artifact from 4.6.2 to 7.0.1 (#20)

=== 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.

'''''
59 changes: 0 additions & 59 deletions CHANGELOG.md

This file was deleted.

24 changes: 24 additions & 0 deletions CODE_OF_CONDUCT.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
== Contributor Covenant Code of Conduct

=== Our Pledge

We pledge to make participation a harassment-free experience for
everyone.

=== Our Standards

*Positive behavior:* * Using welcoming language * Being respectful of
differing viewpoints * Accepting constructive criticism * Focusing on
what is best for the community

*Unacceptable behavior:* * Harassment, trolling, or personal attacks *
Publishing private information without permission

=== Enforcement

Report issues to the maintainers. All complaints will be reviewed.

=== Attribution

Adapted from https://www.contributor-covenant.org/[Contributor Covenant]
v2.1.
30 changes: 0 additions & 30 deletions CODE_OF_CONDUCT.md

This file was deleted.

Loading
Loading