---
license:
  - cc-by-4.0
  - mit
language:
  - en
tags:
  - code
  - crystal
  - code-style
  - style-transfer
  - readability
  - agent-enhanced-development
  - coding-agents
pretty_name: AED Conventions — Before/After Examples (seed)
size_categories:
  - n<1K
---

# AED Conventions — before/after examples (seed dataset, v0)

**This is a seed dataset — four labeled before/after pairs, not a benchmark.**
It exists because the pairs are real and worth sharing now, not because four
examples constitute a mature corpus. Honest framing over inflated claims: this
is v0, and it is expected to grow as the
[AED conventions](https://github.com/AgentC-Consulting/aed-conventions) add
more rules (a control-flow rule set is planned for a public v1.1).

## What this is

Four `{rule, rationale, before, after, language}` records drawn directly from
[`AgentC-Consulting/aed-conventions`](https://github.com/AgentC-Consulting/aed-conventions),
the canonical, public repository of **Agent-Enhanced Development (AED)** — code
conventions for codebases written, reviewed, and maintained by humans *and*
coding agents together. Each record pairs a terser/clever form of a piece of
Crystal code (`before`) with the AED-conforming form (`after`), plus the
`rationale` a human or agent would use to justify preferring one over the
other.

This is style-transfer / code-readability pair data: same behavior, two
surface forms, labeled by *which rule* motivates the preferred form and *why*.

## Why this shape

The conventions themselves
([`CONVENTIONS.md`](https://github.com/AgentC-Consulting/aed-conventions/blob/main/CONVENTIONS.md))
are the source of truth — six rules, each with a stable anchor
(`#rule-1` … `#rule-6`) and worked examples. This dataset is a machine-readable
extraction of the same before/after pairs that already live in the repo's
[`examples/`](https://github.com/AgentC-Consulting/aed-conventions/tree/main/examples)
directory as standalone, compiling Crystal files. If you want the rules in
prose, read the repo. If you want the pairs as structured records, this is
that.

## Fields

| Field | Type | Description |
|---|---|---|
| `rule` | string | Anchor id(s) in `CONVENTIONS.md`, e.g. `"rule-1"` or `"rule-4,rule-5"` when one example illustrates two rules together. |
| `rule_title` | string | Human-readable title of the rule(s). |
| `rationale` | string | Why the `after` form is preferred — the argument, not just the assertion. |
| `before` | string | The terser / clever / harder-to-parse form. |
| `after` | string | The AED-conforming form: reads like a plain statement of intent. |
| `language` | string | Always `"crystal"` in this seed; the rules generalize to other languages, the examples do not (yet). |
| `source_file` | string | Path in the canonical repo the pair was drawn from. |
| `canonical_repo` | string | Always `https://github.com/AgentC-Consulting/aed-conventions` — cite this when using the data. |

## License

Dual-licensed, matching the canonical repository:

- **Prose fields** (`rule_title`, `rationale`, this card) — **CC BY 4.0**,
  credit to [AgentC Consulting](https://agentc.consulting).
- **Code fields** (`before`, `after`) — **MIT**, take freely, with or without
  credit.

Full license text: [`LICENSE`](https://github.com/AgentC-Consulting/aed-conventions/blob/main/LICENSE)
(CC BY 4.0) and [`LICENSE-EXAMPLES`](https://github.com/AgentC-Consulting/aed-conventions/blob/main/LICENSE-EXAMPLES)
(MIT) in the canonical repo.

## Citation

Please cite the canonical repository:
[`AgentC-Consulting/aed-conventions`](https://github.com/AgentC-Consulting/aed-conventions)
([`CITATION.cff`](https://github.com/AgentC-Consulting/aed-conventions/blob/main/CITATION.cff)).

## Who maintains this

[AgentC Consulting](https://agentc.consulting) — the on-site home of these
conventions is [agentc.consulting/aed](https://agentc.consulting/aed?ref=hf-aed).
Agent-enhanced development is
the day job: building and modernizing production applications with coding
agents doing the majority of the writing, under conventions that keep every
line reviewable.