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.

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

All notable changes to `+polysafe-gitfixer+` 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(crg): add crg-grade and crg-badge justfile recipes
* feat: add stapeln.toml container definition
* feat: add UX Justfile with doctor, tour, help-me, assail recipes
* feat: deploy UX Manifesto infrastructure
* feat: add CLADE.a2ml — clade taxonomy declaration
* feat(ci): enable Hypatia scanning

==== Fixed

* fix(ci): bump a2ml/k9-validate-action pins to canonical (#19)
* fix(ci): sync hypatia-scan.yml to canonical (#18)
* fix(ci): Phase-2 fleet submission must not fail the security gate
(#17)
* fix(ci): hypatia-scan workdir ($\{\{ env.HOME }} resolves empty) (#16)
* fix(ci): hypatia-scan.yml – –exit-zero + GITHUB_TOKEN
(hyperpolymath/hypatia#213) (#13)
* fix(ci): rsr-antipattern duplicate heredoc + setup-beam ubuntu24 (#14)
* fix(ci): update hypatia binary detection (check '`hypatia`' before
'`hypatia-v2`')
* fix: implement NIF bindings for polysafe-gitfixer, replacing 12 hollow
stubs
* fix(scorecard): enforce granular permissions and add fuzzing
placeholder
* fix(ci): Resolve workflow-linter self-matching and metadata issues

==== Changed

* refactor: migrate 6SCM → 6A2 (.scm → .a2ml format)

==== Documentation

* docs: substantive CRG C annotation (EXPLAINME.adoc)
* docs: add TEST-NEEDS.md and/or PROOF-NEEDS.md from audit
* docs: add EXPLAINME.adoc — prove-it file backing README claims
* docs: update SCM files with project information
* docs: add CONTRIBUTING.md
* docs: add SCM checkpoint files
* docs: add checkpoint files for state tracking

==== CI

* ci: redistribute concurrency-cancel guard to read-only check workflows
(#21)
* ci: bump actions/upload-artifact SHA to current v4 (#12)
* ci: SHA-pin hyperpolymath validate-actions in dogfood-gate
* ci(antipattern): fix top-level dir + benchmark/lsp filename matching
(#11)
* ci(antipattern): TS check reads .claude/CLAUDE.md exemption table
(#10)

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

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

This file was deleted.

131 changes: 15 additions & 116 deletions CODE_OF_CONDUCT.adoc
Original file line number Diff line number Diff line change
@@ -1,125 +1,24 @@
// SPDX-License-Identifier: CC-BY-SA-4.0
// Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
= Code of Conduct
:toc:
:toc-placement!:
== Contributor Covenant Code of Conduct

toc::[]
=== Our Pledge

== Our Pledge
We pledge to make participation a harassment-free experience for
everyone.

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, caste, color, religion, or sexual
identity and orientation.
=== Our Standards

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.
*Positive behavior:* * Using welcoming language * Being respectful of
differing viewpoints * Accepting constructive criticism * Focusing on
what is best for the community

== Our Standards
*Unacceptable behavior:* * Harassment, trolling, or personal attacks *
Publishing private information without permission

=== Positive Behaviors
=== Enforcement

Examples of behavior that contributes to a positive environment:
Report issues to the maintainers. All complaints will be reviewed.

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility for our mistakes and learning from them
* Focusing on what is best for the overall community
* Using welcoming and inclusive language
* Being patient with newcomers learning the codebase
=== Attribution

=== Unacceptable Behaviors

Examples of unacceptable behavior:

* The use of sexualized language or imagery, and sexual attention or advances
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information without explicit permission
* Deliberately intimidating, stalking, or following
* Other conduct which could reasonably be considered inappropriate

== Scope

This Code of Conduct applies within all community spaces, including:

* GitLab/GitHub repositories (issues, merge requests, comments)
* Project documentation and wikis
* Community chat channels
* Project events and meetups
* Social media interactions representing the project

It also applies when an individual is officially representing the community
in public spaces.

== Enforcement

=== Reporting

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the project maintainers listed in `MAINTAINERS.md`.

All complaints will be reviewed and investigated promptly and fairly.
Maintainers are obligated to respect the privacy and security of the
reporter of any incident.

=== Enforcement Guidelines

Maintainers will follow these guidelines in determining consequences:

==== 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional.

**Consequence**: A private, written warning providing clarity around the
nature of the violation and an explanation of why the behavior was
inappropriate. A public apology may be requested.

==== 2. Warning

**Community Impact**: A violation through a single incident or series of
actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved for a specified period. This includes
avoiding interactions in community spaces as well as external channels.
Violating these terms may lead to a temporary or permanent ban.

==== 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period. No public or
private interaction with the people involved is allowed during this period.
Violating these terms may lead to a permanent ban.

==== 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment, or
aggression toward individuals or groups.

**Consequence**: A permanent ban from any sort of public interaction within
the community.

== Attribution

This Code of Conduct is adapted from the
https://www.contributor-covenant.org[Contributor Covenant], version 2.1,
available at
https://www.contributor-covenant.org/version/2/1/code_of_conduct.html

Community Impact Guidelines were inspired by
https://github.com/mozilla/diversity[Mozilla's code of conduct enforcement ladder].

== Questions

For questions about this Code of Conduct, please open an issue or contact
the maintainers directly.
Adapted from https://www.contributor-covenant.org/[Contributor Covenant]
v2.1.
Loading
Loading