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.

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

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

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

=== [Unreleased]

==== Planned

* Browser extension versions (Firefox, Chrome)
* GitHub Action integration
* GitLab CI/CD template library
* Rhodium Register publication
* Badge generation service
* VS Code extension
* CLI standalone tool

=== [1.0.0] - 2025-01-22

==== Added - RSR Bronze Compliance

*Core Implementation*: - Repo Structure Bootstrapper module (TypeScript)
- Community Standards Helper module (TypeScript) - Golden Registry
Auditor module (TypeScript) - Offline-first architecture (zero network
dependencies) - Type-safe implementation (TypeScript strict mode) -
Comprehensive test suite (100% pass rate)

*Documentation*: - README.md with comprehensive project overview -
LICENSE.txt (dual MIT + Palimpsest v0.8) - SECURITY.md with
vulnerability reporting procedures - CONTRIBUTING.md with TPCF
(Tri-Perimeter Contribution Framework) - CODE_OF_CONDUCT.md with
emotional safety provisions - MAINTAINERS.md with governance structure -
CHANGELOG.md (this file)

*.well-known Directory*: - security.txt (RFC 9116 compliant) - ai.txt
(AI training policies) - humans.txt (attribution and credits)

*Build System*: - Justfile with 20+ automation recipes - package.json
with npm scripts - TypeScript configuration (strict mode) - ESLint and
Prettier setup - Nix flake for reproducible builds

*CI/CD*: - .gitlab-ci.yml with comprehensive pipeline - Automated
testing on every push - Type checking and linting - Security scanning
(SAST, secret detection) - RSR compliance validation

*Tests*: - Unit tests for all core modules - Integration tests for
module interactions - 100% test coverage goal - Automated test runs in
CI/CD

==== Infrastructure

* GitLab repository established
* Issue templates for bugs, features, security
* Merge request templates
* Community health files

==== Compliance

* *RSR Bronze Level* achieved
* *TPCF Perimeter 3* (Community Sandbox)
* *Offline-first* verified
* *Type safety* via TypeScript
* *Memory safety* via immutable patterns
* *Zero runtime dependencies*

'''''

=== Version History

==== Versioning Scheme

We use https://semver.org/[Semantic Versioning]:

*MAJOR.MINOR.PATCH*

* *MAJOR*: Breaking changes (incompatible API changes)
* *MINOR*: New features (backwards-compatible)
* *PATCH*: Bug fixes (backwards-compatible)

==== Release Types

* *Stable Releases* (1.0.0, 1.1.0, etc.): Production-ready
* *Pre-releases* (1.0.0-beta.1, 1.0.0-rc.2): Testing only
* *Development* (unreleased): Main branch, unstable

==== Categories

Changes are categorized as:

* *Added*: New features
* *Changed*: Changes to existing functionality
* *Deprecated*: Soon-to-be-removed features
* *Removed*: Removed features
* *Fixed*: Bug fixes
* *Security*: Security vulnerability fixes

==== Breaking Changes

Breaking changes are always: - Highlighted in *bold* with
"`**BREAKING:**`" prefix - Documented in upgrade guides - Accompanied by
major version bump - Announced with migration period (when possible)

'''''

=== Links

* https://gitlab.com/extensions-library/monkey-scripts/grimrepo-scripts[GitLab
Repository]
* https://gitlab.com/extensions-library/monkey-scripts/grimrepo-scripts/-/issues[Issue
Tracker]
* https://gitlab.com/extensions-library/monkey-scripts/grimrepo-scripts/-/releases[Releases]
* https://gitlab.com/extensions-library/monkey-scripts/grimrepo-scripts/-/security/advisories[Security
Advisories]

'''''

*Maintained by*: GrimRepo Contributors *Last Updated*: 2025-01-22
130 changes: 0 additions & 130 deletions CHANGELOG.md

This file was deleted.

Loading
Loading