Skip to content

Commit 3d8b7cf

Browse files
refactor: migrate Markdown to AsciiDoc (#104)
Automated migration of .md to .adoc per global rules, preserving wikis and critical exceptions.
1 parent d7a7b2b commit 3d8b7cf

16 files changed

Lines changed: 449 additions & 471 deletions

ARCHITECTURE.adoc

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
== Architecture
2+
3+
=== Overview
4+
5+
This repository follows a modular, maintainable architecture designed
6+
for clarity, scalability, and long-term sustainability.
7+
8+
=== Directory Structure
9+
10+
....
11+
.
12+
├── src/ # Source code
13+
├── tests/ # Test suites
14+
├── docs/ # Documentation
15+
├── scripts/ # Utility scripts
16+
├── config/ # Configuration files
17+
├── LICENSE # License file
18+
├── LICENSES/ # Full license texts
19+
└── README.adoc # Project documentation
20+
....
21+
22+
=== Design Principles
23+
24+
* *Separation of Concerns*: Each module has a single responsibility
25+
* *Testability*: Code is written to be easily testable
26+
* *Documentation*: All public APIs are documented
27+
* *Configuration*: Environment-specific settings are externalized
28+
29+
=== Dependencies
30+
31+
* External dependencies are minimized and clearly declared
32+
* Version pinning is used for reproducibility
33+
34+
=== Security Considerations
35+
36+
* Sensitive data is never committed to the repository
37+
* Secrets are managed through environment variables or secure vaults
38+
* Regular dependency audits are performed
39+
40+
=== Maintainability
41+
42+
* Code follows consistent style guidelines
43+
* Pull requests require review and CI checks
44+
* Issues and discussions are tracked transparently
45+
46+
'''''
47+
48+
_Last updated: 2026-07-18_

ARCHITECTURE.md

Lines changed: 0 additions & 47 deletions
This file was deleted.

CHANGELOG.adoc

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
== Changelog
2+
3+
All notable changes to `+modshells+` will be documented in this file.
4+
5+
This file is generated from conventional commits by the
6+
https://github.com/hyperpolymath/standards/blob/main/.github/workflows/changelog-reusable.yml[`+changelog-reusable.yml+`]
7+
workflow (`+hyperpolymath/standards#206+`). Adopt the workflow in this
8+
repo’s CI to keep this file in sync automatically — see
9+
https://github.com/hyperpolymath/standards/blob/main/templates/cliff.toml[`+templates/cliff.toml+`]
10+
for the canonical config.
11+
12+
The format follows https://keepachangelog.com/en/1.1.0/[Keep a
13+
Changelog]; this project aims to follow
14+
https://semver.org/spec/v2.0.0.html[Semantic Versioning].
15+
16+
=== [Unreleased]
17+
18+
==== Added
19+
20+
* feat(validator): add comprehensive shell validation package
21+
* feat: Switch mirror workflow to SSH
22+
* feat(init): Rhodium Standard project structure (v0.0) with Ada, LMDB
23+
stubs, and GitLab CI.
24+
25+
==== Fixed
26+
27+
* fix(ci): sync hypatia-scan.yml to canonical (#46)
28+
* fix(ci): point CodeQL at `+actions+` so SAST runs every commit (#72)
29+
(#41)
30+
* fix(ci): adopt canonical hypatia-scan.yml (#39)
31+
* fix(security): update editorconfig SHA and CodeQL language
32+
* fix: correct author name in CITATION.cff
33+
* fix(ci): update quality.yml workflow
34+
* fix: align CodeQL with repo languages (robot-cleaner)
35+
36+
==== Changed
37+
38+
* refactor: Rename project to '`modshells`' for conciseness and update
39+
GNAT project file (Rhodium Standard).
40+
41+
==== Documentation
42+
43+
* docs(proof): modshells SPARK no-op exemption (reconcile stale audit)
44+
(#49)
45+
46+
==== CI
47+
48+
* ci(spark): adopt estate SPARK Theatre Gate (#135) (#50)
49+
50+
=== Pre-history
51+
52+
Prior commits to this file’s introduction are recorded in git history
53+
but not formally classified into Keep-a-Changelog sections. To backfill,
54+
run `+git cliff -o CHANGELOG.md+` locally using the canonical
55+
https://github.com/hyperpolymath/standards/blob/main/templates/cliff.toml[`+cliff.toml+`]
56+
— this is one-shot mechanical work.
57+
58+
'''''

CHANGELOG.md

Lines changed: 0 additions & 54 deletions
This file was deleted.

CODE_OF_CONDUCT.adoc

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
== Contributor Covenant Code of Conduct
2+
3+
=== Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in
6+
our community a harassment-free experience for everyone, regardless of
7+
age, body size, visible or invisible disability, ethnicity, sex
8+
characteristics, gender identity and expression, level of experience,
9+
education, socio-economic status, nationality, personal appearance,
10+
race, religion, or sexual identity and orientation.
11+
12+
=== Our Standards
13+
14+
Examples of behavior that contributes to a positive environment include:
15+
16+
* Demonstrating empathy and kindness toward other people
17+
* Being respectful of differing opinions, viewpoints, and experiences
18+
* Giving and gracefully accepting constructive feedback
19+
* Accepting responsibility and apologizing to those affected by our
20+
mistakes
21+
22+
Examples of unacceptable behavior include:
23+
24+
* The use of sexualized language or imagery
25+
* Trolling, insulting or derogatory comments, and personal or political
26+
attacks
27+
* Public or private harassment
28+
* Publishing others’ private information without explicit permission
29+
30+
=== Enforcement
31+
32+
Instances of abusive, harassing, or otherwise unacceptable behavior may
33+
be reported to the project maintainers. All complaints will be reviewed
34+
and investigated promptly and fairly.
35+
36+
=== Attribution
37+
38+
This Code of Conduct is adapted from the
39+
https://www.contributor-covenant.org[Contributor Covenant], version 2.1.

CODE_OF_CONDUCT.md

Lines changed: 0 additions & 41 deletions
This file was deleted.

0 commit comments

Comments
 (0)