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
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.
27 changes: 0 additions & 27 deletions CODE_OF_CONDUCT.md

This file was deleted.

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

Thank you for your interest in contributing! We follow a "`Dual-Track`"
architecture where human-readable documentation lives in the root and
machine-readable policies live in `+.machine_readable/+`.

=== How to Contribute

We welcome contributions in many forms:

* *Code:* Improving the core stack or extensions
* *Documentation:* Enhancing docs or AI manifests
* *Testing:* Adding property-based tests or formal proofs
* *Bug reports:* Filing clear, reproducible issues

=== Getting Started

[arabic]
. *Read the AI Manifest:* Start with `+0-AI-MANIFEST.a2ml+` (if present)
to understand the repository structure.
. *Environment:* Use `+nix develop+` or `+direnv allow+` to set up your
tools.
. *Task Runner:* Use `+just+` to see available commands
(`+just --list+`).

=== 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 license as the project (see LICENSE).
66 changes: 0 additions & 66 deletions CONTRIBUTING.md

This file was deleted.

21 changes: 12 additions & 9 deletions SECURITY.md → SECURITY.adoc
Original file line number Diff line number Diff line change
@@ -1,21 +1,24 @@
# Security Policy
== Security Policy

## Supported Versions
=== Supported Versions

| Version | Supported |
|---------|-----------|
| 0.1.x | ✅ |
[cols=",",options="header",]
|===
|Version |Supported
|0.1.x |✅
|===

## Reporting a Vulnerability
=== Reporting a Vulnerability

Please report security vulnerabilities to: j.d.a.jewell@open.ac.uk

Do NOT open a public issue for security vulnerabilities.

## Response Time
=== Response Time

We aim to respond within 48 hours and provide a fix within 7 days for critical issues.
We aim to respond within 48 hours and provide a fix within 7 days for
critical issues.

## Scope
=== Scope

This policy covers the mylangiser CLI tool and its generated artifacts.
30 changes: 30 additions & 0 deletions TEST-NEEDS.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
== TEST-NEEDS.md — mylangiser

=== CRG Grade: C — ACHIEVED 2026-04-04

=== Current Test State

[cols=",,",options="header",]
|===
|Category |Count |Notes
|Test files |2 |Current state
|===

=== What’s Covered

* [x] 2 existing test file(s)
* [x] Rust integration tests

=== Still Missing (for CRG B+)

* [ ] Zig FFI tests (if applicable)
* [ ] CI/CD test automation
* [ ] Property-based tests
* [ ] Edge case coverage

=== Run Tests

[source,bash]
----
cargo test --all
----
27 changes: 0 additions & 27 deletions TEST-NEEDS.md

This file was deleted.

27 changes: 16 additions & 11 deletions TOPOLOGY.md → TOPOLOGY.adoc
Original file line number Diff line number Diff line change
@@ -1,14 +1,19 @@
<!-- SPDX-License-Identifier: CC-BY-SA-4.0 -->
<!-- Copyright (c) 2026 Jonathan D.A. Jewell (hyperpolymath) <j.d.a.jewell@open.ac.uk> -->
# TOPOLOGY.md — mylangiser
== TOPOLOGY.md — mylangiser

## Purpose
=== Purpose

mylangiser generates progressive-disclosure interfaces for complex APIs via My-Lang. It analyses API complexity, scores each endpoint, and assigns disclosure levels (beginner / intermediate / expert), then generates layered wrapper code with smart defaults for omitted parameters. The goal is to make any API learnable by newcomers while remaining fully expressive for experts. mylangiser targets library and API authors who want to reduce the cognitive load on users without sacrificing power.
mylangiser generates progressive-disclosure interfaces for complex APIs
via My-Lang. It analyses API complexity, scores each endpoint, and
assigns disclosure levels (beginner / intermediate / expert), then
generates layered wrapper code with smart defaults for omitted
parameters. The goal is to make any API learnable by newcomers while
remaining fully expressive for experts. mylangiser targets library and
API authors who want to reduce the cognitive load on users without
sacrificing power.

## Module Map
=== Module Map

```
....
mylangiser/
├── src/
│ ├── main.rs # CLI entry point (clap): init, validate, generate, build, run, info
Expand All @@ -20,11 +25,11 @@ mylangiser/
├── verification/ # Proof harnesses
├── container/ # Stapeln container ecosystem
└── .machine_readable/ # A2ML metadata
```
....

## Data Flow
=== Data Flow

```
....
mylangiser.toml manifest
┌────▼────┐
Expand All @@ -39,4 +44,4 @@ mylangiser.toml manifest
┌────▼────┐
│ Codegen │ emit generated/mylangiser/ (layered wrappers with smart defaults)
└─────────┘
```
....
Loading
Loading