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.

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

All notable changes to `+nickel-augmentation+` 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: nickel-augmentation 1.0.0 — proven bridge, K9 signatures, 48
tests
* feat: proven bridge — Nickel contracts backed by Idris2 formal proofs
* feat: 7 new reporter rules, K9 runner, 29 integration tests
* feat: add stapeln.toml container definition
* feat: deploy UX Manifesto infrastructure
* feat: add CLADE.a2ml — clade taxonomy declaration
* feat: add Nickel contract library, config-reporter CLI, and wire
Justfile
* feat: add RSR template structure and project metadata
* feat: consolidate nickel repos into nickel-augmentation monorepo

==== Fixed

* fix(ci): bump a2ml/k9-validate-action pins to canonical (standards#85)
(#9)
* fix(ci): sync hypatia-scan.yml to canonical (kill cd-scanner build
drift) (#8)
* fix(ci): build Hypatia escript from repo root (estate dogfood drift)
* fix(ci): Phase-2 fleet submission must not fail the security gate (#5)
* fix(ci): repair YAML block-scalar in workflow-linter Check Permissions
step (#3)
* fix(scorecard): enforce granular permissions and add fuzzing
placeholder
* fix(ci): Resolve workflow-linter self-matching and metadata issues
* fix: correct email jonathan.jewell → j.d.a.jewell
* fix: SPDX headers (AGPL→PMPL), email, author name

==== Changed

* refactor: migrate 6SCM → 6A2 (.scm → .a2ml format)

==== Documentation

* docs: substantive CRG C annotation (EXPLAINME.adoc)
* docs: add TEST-NEEDS.md and/or PROOF-NEEDS.md from audit
* docs: add EXPLAINME.adoc — prove-it file backing README claims

==== CI

* ci: redistribute concurrency-cancel guard to read-only check workflows
(#12)
* ci: fix nonexistent actions/upload-artifact SHA pin (#7)
* ci: bump actions/upload-artifact SHA to current v4 (#2)
* ci: SHA-pin hyperpolymath validate-actions in dogfood-gate
* ci: restore Dependabot security path + wire auto-merge

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

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

This file was deleted.

Loading
Loading