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.

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

All notable changes to this project will be documented in this file.

The format is based on https://keepachangelog.com/en/1.1.0/[Keep a
Changelog], and this project adheres to
https://semver.org/spec/v2.0.0.html[Semantic Versioning].

=== [Unreleased]

==== Added

* Instantiated this repository as *systemet — Equality Theory*
(`+system+` + `+ET+`), the stratified type theory the `+anytype+` kernel
implements.
* Authored `+README.adoc+` and `+EXPLAINME.adoc+` for the theory: the
five layers, the L1 equality-is-conversion cut, the three gates
(Totality/Structural/Polarity), roles-as-tropes, and TEA-erasure as an
open proof obligation.
* Instantiated identity descriptiles (CLADE/ECOSYSTEM/ANCHOR/STATE/META)
and the AFFIRMATION honesty snapshot with the systemet identity and an
honest status (theory specified; proofs OPEN; no compiler here).

==== Changed

* Split the theory out of the earlier combined "`EveryType`" draft. The
over-claiming "`EveryType`" name is retired; the kernel half now lives
in the `+anytype+` repo and this repo holds the theory.

==== Notes

* `+uuid+` is a PROVISIONAL deterministic UUIDv5 of the forge URL;
`+clade+` is PROVISIONAL. Both must be confirmed/registered in
`+gv-clade-index+`.
* `+CLAUDE.md+` is generated from the descriptiles — run
`+just claude-md+` to refresh it where `+nickel+`/`+just+` are
available.
36 changes: 0 additions & 36 deletions CHANGELOG.md

This file was deleted.

75 changes: 75 additions & 0 deletions CONTRIBUTING.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
== Contributing to systemet

Thanks for your interest. This repository follows the Hyperpolymath
estate standards defined in
https://github.com/hyperpolymath/standards[hyperpolymath/standards].

=== Licence

This project is licensed under *MPL-2.0*. By contributing you agree that
your contributions are licensed under the same terms. Every source file
carries an `+SPDX-License-Identifier+` header; keep it when editing, and
add one to any new file.

=== Development environment

A pinned dev shell is provided:

[source,sh]
----
nix develop # toolchain: just
----

Estate policy is Guix primary / Nix fallback; this repo currently ships
the Nix fallback. A `+guix.scm+` is welcome if you prefer the primary
tier.

=== Build and test

This repo uses https://just.systems[`+just+`] (the estate uses
Justfiles, never Makefiles). Recipes available here:

[source,sh]
----
just # list recipes
just fmt # format
just fmt-check # check formatting
just lint # lint
just test-all # run the full suite
just doctor # environment diagnostics
----

=== Machine-readable artefacts

This repo carries `+.machine_readable/+` A2ML files (`+STATE.a2ml+`,
`+META.a2ml+`, `+ECOSYSTEM.a2ml+`, `+AGENTIC.a2ml+`, `+NEUROSYM.a2ml+`,
`+PLAYBOOK.a2ml+`). If your change alters project state, architecture,
or operational steps, update the corresponding file in the same PR — CI
validates them.

=== Language policy

The estate restricts which languages may be used. In particular Python,
Go, TypeScript, ReScript, V-lang, Java/Kotlin, Swift and Makefiles are
*not* accepted in new code; AffineScript, Rust/SPARK, Zig, Deno, Gleam,
Elixir, Haskell, Idris2, Agda, Julia and OCaml are. CI enforces this, so
check the policy in `+hyperpolymath/standards+` before introducing a new
language.

=== Documentation format

Docs are AsciiDoc (`+.adoc+`) by default, including `+README.adoc+`. The
GitHub-required community-health files stay Markdown: `+SECURITY.md+`,
`+CONTRIBUTING.md+`, `+CODE_OF_CONDUCT.md+`, `+CHANGELOG.md+`. Do not
add a `+.md+` duplicate of a doc that already exists as `+.adoc+`.

=== Pull requests

[arabic]
. Branch from `+main+` — do not push to `+main+` directly; branch
protection requires review and passing checks.
. Keep the change focused, and explain _why_ in the PR body.
. Make sure governance CI is green. It checks documentation presence,
packaging policy, secrets, licence consistency and workflow security.
. Security issues: follow `+SECURITY.md+` — report privately, never in a
public issue.
72 changes: 0 additions & 72 deletions CONTRIBUTING.md

This file was deleted.

Loading
Loading