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.

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

All notable changes to `+modshells+` 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(validator): add comprehensive shell validation package
* feat: Switch mirror workflow to SSH
* feat(init): Rhodium Standard project structure (v0.0) with Ada, LMDB
stubs, and GitLab CI.

==== Fixed

* fix(ci): sync hypatia-scan.yml to canonical (#46)
* fix(ci): point CodeQL at `+actions+` so SAST runs every commit (#72)
(#41)
* fix(ci): adopt canonical hypatia-scan.yml (#39)
* fix(security): update editorconfig SHA and CodeQL language
* fix: correct author name in CITATION.cff
* fix(ci): update quality.yml workflow
* fix: align CodeQL with repo languages (robot-cleaner)

==== Changed

* refactor: Rename project to '`modshells`' for conciseness and update
GNAT project file (Rhodium Standard).

==== Documentation

* docs(proof): modshells SPARK no-op exemption (reconcile stale audit)
(#49)

==== CI

* ci(spark): adopt estate SPARK Theatre Gate (#135) (#50)

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

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

This file was deleted.

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

=== Our Pledge

We as members, contributors, and leaders pledge to make participation in
our community a harassment-free experience for everyone, regardless of
age, body size, visible or invisible disability, ethnicity, sex
characteristics, gender identity and expression, level of experience,
education, socio-economic status, nationality, personal appearance,
race, religion, or sexual identity and orientation.

=== Our Standards

Examples of behavior that contributes to a positive environment include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our
mistakes

Examples of unacceptable behavior include:

* The use of sexualized language or imagery
* Trolling, insulting or derogatory comments, and personal or political
attacks
* Public or private harassment
* Publishing others’ private information without explicit permission

=== Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may
be reported to the project maintainers. All complaints will be reviewed
and investigated promptly and fairly.

=== Attribution

This Code of Conduct is adapted from the
https://www.contributor-covenant.org[Contributor Covenant], version 2.1.
41 changes: 0 additions & 41 deletions CODE_OF_CONDUCT.md

This file was deleted.

Loading
Loading