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.

50 changes: 50 additions & 0 deletions CLOSE-OUT.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
== A2ML Ecosystem — Close-Out

Decision ledger for the coordination-hub rebuild.

=== Decided

* *Shape.* The hub is a coordination hub plus pinned submodules — a
sibling of `+developer-ecosystem+` and a satellite of
`+hyperpolymath/standards+`.
* *Spec home.* The A2ML specification lives in
`+hyperpolymath/standards+` (`+docs/A2ML-SPEC.adoc+`). This hub pins it
by tag; it does not own it.
* *Drift model.* Pin + verify: upstream spec and governance are
referenced by pinned tag and checked in CI, never hard-linked or copied.
* *Members.* 12 members across implementations / tooling / ci /
examples, pinned as submodule gitlinks on `+main+`.
`+contractiles-a2-lab+` is excluded (private) and only cross-referenced.
* *Governance layout.* Machine-readable metadata lives under
`+.machine_readable/+` only; `+0-AI-MANIFEST.a2ml+` is the root entry
point.
* *Conformance verified.* 4 valid + 5 invalid `+.a2ml+` fixtures,
indexed by `+conformance/manifest.a2ml+`: valid validates with 0 errors;
invalid (strict) errors on every case.

=== Issues (filed)

* Pin canonical spec in standards + replace TODO-tag —
`+decision, governance+`
* Member rollout: ANCHOR satellite+pin+conformance CI; enable
upstream-pins — `+rollout+`
* Canonical parse-AST (expected.json) + expand conformance corpus —
`+conformance+`
* Governance parity: stamp standard `+.machine_readable+` +
CONTRIBUTING/SECURITY/COC from standards — `+governance+`
* Author tiered dev/maintainer/user docs + concept guides — `+docs+`
* Reference this hub from developer-ecosystem / standards — `+meta+`
* Ratify a2mliser (in) + contractiles-a2-lab (cross-ref) — `+decision+`

=== Discarded

* Bundling member sources into the hub (rejected: members stay
independent).
* WSL-specific tooling assumptions (rejected: not portable).
* base64-embedded payloads for fixtures or metadata (rejected: opaque
and unverifiable).

=== Cleanup

* After the PR merges, delete the development branch
`+claude/gracious-goodall-4vnq77+`.
43 changes: 0 additions & 43 deletions CLOSE-OUT.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.
26 changes: 0 additions & 26 deletions CODE_OF_CONDUCT.md

This file was deleted.

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

Thank you for your interest in contributing! This repository is a
*coordination hub* and a satellite of `+hyperpolymath/standards+`: it
does not own the A2ML specification or governance — those are pinned
from `+standards+` — but it owns the conformance fixtures, the
membership manifest, and the cross-repo drift CI. Human-readable
documentation lives in the root; machine-readable metadata lives under
`+.machine_readable/+`.

=== How to Contribute

We welcome contributions in many forms:

* *Conformance fixtures:* Add or refine cases under
`+conformance/valid/+` and `+conformance/invalid/+` (keep
`+conformance/manifest.a2ml+` in sync).
* *Membership:* Propose member additions/removals via
`+.machine_readable/6a2/ECOSYSTEM.a2ml+`, kept in lockstep with
`+.gitmodules+` and `+scripts/check-membership.sh+`.
* *Drift CI & tooling:* Improve `+.github/workflows/anchor-drift.yml+`
or the helper `+scripts/+`.
* *Documentation:* Enhance the docs or the AI manifest.
* *Bug reports:* File clear, reproducible issues.

=== Getting Started

[arabic]
. *Read the AI Manifest:* Start with `+0-AI-MANIFEST.a2ml+` to
understand the repository structure.
. *Initialise members:* Run `+scripts/init-submodules.sh+` to populate
`+members/+` (each member is pinned by commit).
. *Check membership:* Run `+scripts/check-membership.sh+` to verify the
manifest, `+.gitmodules+`, and submodule declarations agree.
. *Validate conformance:* Run the A2ML validator
(`+hyperpolymath/a2ml-validate-action+`) over `+conformance/valid+`
(expect 0 errors) and over `+conformance/invalid+` with strict mode
(every case must error).

=== Development Workflow

==== Branch Naming

....
docs/short-description # Documentation
test/what-added # Test additions
feat/short-description # New features
fix/issue-number-description # Bug fixes
refactor/what-changed # Code improvements
security/what-fixed # Security fixes
....

==== Commit Messages

We follow https://www.conventionalcommits.org/[Conventional Commits]:

....
<type>(<scope>): <description>

[optional body]

[optional footer]
....

Types: `+feat+`, `+fix+`, `+docs+`, `+test+`, `+refactor+`, `+ci+`,
`+chore+`, `+security+`

=== Reporting Bugs

Before reporting: 1. Search existing issues 2. Check if it’s already
fixed in `+main+`

When reporting, include: - Clear, descriptive title - Environment
details (OS, versions, toolchain) - Steps to reproduce - Expected vs
actual behaviour

=== Code of Conduct

All contributors are expected to adhere to our
link:CODE_OF_CONDUCT.md[Code of Conduct].

=== License

By contributing, you agree that your contributions will be licensed
under the same licenses as the project: code under MPL-2.0 and
documentation under CC-BY-SA-4.0 (see LICENSE and LICENSES/).
68 changes: 0 additions & 68 deletions CONTRIBUTING.md

This file was deleted.

Loading
Loading