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

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

All notable changes to `+maa-framework+` 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(crg): add crg-grade and crg-badge justfile recipes
* feat: add comprehensive test suite to achieve CRG C compliance
* feat: add benchmarks, unit tests, E2E and aspect tests for
absolute-zero
* feat: add stapeln.toml container definition
* feat: deploy UX Manifesto infrastructure
* feat: add CLADE.a2ml — clade taxonomy declaration

==== Fixed

* fix(baseline): unblock 2 baseline-rot checks blocking dependabot #69
(#70)
* fix(ci): pin upload-artifact to valid SHA in hypatia-scan.yml (Refs
standards#48) (#57)
* fix(ci): bump a2ml/k9-validate-action pins to canonical (#55)
* fix(ci): sync hypatia-scan.yml to canonical (#54)
* fix(ci): build Hypatia escript from repo root (estate dogfood drift)
* fix(ci): adopt canonical hypatia-scan.yml (#52)
* fix(ci): rsr-antipattern.yml duplicate heredoc (#49)
* fix(ci): move secret-scanner Cargo.toml gate from job-level if: to
step-level (#50)
* fix: remove eval, quote vars, use mktemp in absolute-zero shell
scripts
* fix: eliminate all 3 sorry in LambdaCNO proofs

==== Documentation

* docs: substantive CRG C annotation (EXPLAINME.adoc)
* docs(test): achieve CRG C — document all test categories passing
* docs: add EXPLAINME.adoc — prove-it file backing README claims

==== CI

* build(deps): bump dtolnay/rust-toolchain from
efa25f7f19611383d5b0ccf2d1c8914531636bf9 to
3c5f7ea28cd621ae0bf5283f0e981fb97b8a7af9 (#69)
* build(deps): bump haskell-actions/setup from 2.7.5 to 2.11.0 (#68)
* build(deps): bump actions/upload-pages-artifact from 3.0.1 to 5.0.0
(#67)
* build(deps): bump actions/checkout from 4.1.1 to 6.0.2 (#66)
* build(deps): bump actions/configure-pages from 5.0.0 to 6.0.0 (#65)

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

'''''
62 changes: 0 additions & 62 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.

109 changes: 109 additions & 0 deletions CONTRIBUTING.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
== Clone the repository

git clone https://github.com/hyperpolymath/maa-framework.git cd
maa-framework

== Using Nix (recommended for reproducibility)

nix develop

== Or using toolbox/distrobox

toolbox create maa-framework-dev toolbox enter maa-framework-dev #
Install dependencies manually

== Verify setup

just check # or: cargo check / mix compile / etc. just test # Run test
suite

....

### Repository Structure
....

maa-framework/ ├── 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/maa-framework/labels/good%20first%20issue) — Simple Perimeter 3 tasks
- [`help wanted`](https://github.com/hyperpolymath/maa-framework/labels/help%20wanted) — Community help needed
- [`documentation`](https://github.com/hyperpolymath/maa-framework/labels/documentation) — Docs improvements
- [`perimeter-3`](https://github.com/hyperpolymath/maa-framework/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]
Loading
Loading