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.

97 changes: 97 additions & 0 deletions READINESS.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
== iseriser Component Readiness Assessment

*Standard:*
https://github.com/hyperpolymath/standards/tree/main/component-readiness-grades[Component
Readiness Grades (CRG) v2.2] *Current Grade:* B *Assessed:* 2026-04-04
*Assessor:* Jonathan D.A. Jewell + Claude Sonnet 4.6

'''''

=== Summary

[width="100%",cols="16%,6%,13%,65%",options="header",]
|===
|Component |Grade |Release Stage |Evidence Summary
|`+scan+` |B |Beta |Scanned 29 -iser repos across 6 distinct language
stacks

|`+generate+` |C |Alpha-stable |Generates -iser scaffolding; used to
create iseriser itself

|`+validate+` |C |Alpha-stable |Validates manifest; CI passing on self

|CLI / dispatch |C |Alpha-stable |Full command routing; dogfooded on 29
-iser repos
|===

*Overall:* Grade B for the `+scan+` subcommand (primary use case). Grade
C for generator/validator.

'''''

=== Grade B Evidence — `+scan+` External Targets

iseriser `+scan+` has been executed against 29 -iser repos, spanning 6
distinct language/architecture families:

[arabic]
. *Rust CLIs* (conflow, a2ml-rs, panic-attack/assemblyline) — Cargo
workspace, multi-crate
. *Elixir/OTP* (hypatia, burble) — mix.exs umbrella, GenServer pattern
. *Gleam/BEAM* (k9_gleam, a2ml_gleam) — gleam.toml, BEAM target
. *Deno/TypeScript tooling* (k9-coordination-protocol generator) — Deno
runtime
. *Julia scientific* (statistease, developer-ecosystem/julia-ecosystem)
— Project.toml
. *Multi-language monorepos* (developer-ecosystem, standards,
nextgen-languages) — mixed roots

Issues found and fed back during scan development: - Missing
eclexiaiser.toml detection in sub-service dirs (fixed: now uses maxdepth
3) - k9iser path resolution relative to manifest (fixed:
manifest-relative paths) - Groove manifest validation tolerates
`+"type": "custom"+` with warning (deliberate)

'''''

=== Grade C Evidence — `+generate+`

* Successfully scaffolds new -iser repos from template
* Generated: typedqliser, chapeliser, verisimiser, eclexiaiser, +25
others
* Dogfooded: iseriser was generated using itself (bootstrap complete)
* Known limitation: generated ABI stubs are templates only, not proven
Idris2

*Promotion path to B:* Generate on 6 external project types with diverse
requirements and verify the scaffolded code compiles/runs correctly in
each.

'''''

=== Grade C Evidence — `+validate+`

* Validates iseriser.toml manifests (schema, required fields, path
resolution)
* CI passing on own manifest
* Deployed in dogfood-gate on repos with iseriser.toml

*Promotion path to B:* Deploy and validate against 6+ diverse external
-iser manifests with different language stacks.

'''''

=== Concerns and Maintenance Notes

[arabic]
. *ABI stubs* — Generated Idris2 ABI stubs require manual completion;
only scaffold
. *Zig FFI templates* — Generated FFI templates compile but don’t
implement semantics
. *`+scan+` on non-Rust repos* — Performance impact when traversing
large repos with many files
. *Chapel metalayer* — Planned distributed scan; not yet implemented

'''''

=== Run `+just crg-badge+` to generate the shields.io badge for your README.
74 changes: 0 additions & 74 deletions READINESS.md

This file was deleted.

Loading
Loading