{"id":50573226,"url":"https://github.com/adr/yadr","last_synced_at":"2026-06-04T20:01:17.904Z","repository":{"id":344759014,"uuid":"1113022600","full_name":"adr/yadr","owner":"adr","description":null,"archived":false,"fork":false,"pushed_at":"2026-04-14T20:46:54.000Z","size":26,"stargazers_count":8,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-04-14T22:26:07.590Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/adr.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-12-09T12:19:22.000Z","updated_at":"2026-04-14T20:46:55.000Z","dependencies_parsed_at":"2026-03-16T19:03:01.793Z","dependency_job_id":null,"html_url":"https://github.com/adr/yadr","commit_stats":null,"previous_names":["adr/yadr"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/adr/yadr","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adr%2Fyadr","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adr%2Fyadr/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adr%2Fyadr/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adr%2Fyadr/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/adr","download_url":"https://codeload.github.com/adr/yadr/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adr%2Fyadr/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33917184,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-04T02:00:06.755Z","response_time":64,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-06-04T20:01:17.099Z","updated_at":"2026-06-04T20:01:17.881Z","avatar_url":"https://github.com/adr.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# YAML ADRs (YADR)\n\n[YAML](https://en.wikipedia.org/wiki/YAML) is a human-friendly, programming language-independent data serialization language; it is commonly used for configuration files. Its human-friendliness makes YAML suited for the capturing [Architectural Decisions](https://en.wikipedia.org/wiki/Architectural_decision) in [Architecture Decision Records (ADRs)](https://github.com/joelparkerhenderson/architecture-decision-record) as well.\n\nThis repository provides YAML ADR templates and examples.\n\n## Content overview\n\n* [YAML port of the Markdown Architectural Decisions (MADR) template](templates/yadr-template-full.yaml), as well as a [usage example](examples/use-yaml-as-adr-syntax.yaml) for it.\n  * [Bare version of the YADR template](templates/yadr-template-bare.yaml) and shortened [usage example](examples/yaml-as-additional-syntax-for-madr.yaml).\n  * [JSON conversions](examples-validation) of the YADR usage examples validate against the [JSON schema](schemas/yadr-schema.json)[^1] for the template.[^2]\n* The folder [other YAML templates](templates/other-yaml-templates/) contains YAML ports of templates not originating from the MADR project, for instance, the [Y-Statement](https://medium.com/olzzio/y-statements-10eb07b5a177) template.\n  * An [example](examples/other-yaml-templates/yaml-as-additional-y-statement-syntax.yaml) and two corresponding [JSON conversions](examples-validation/other-yaml-templates/) are available as well.\n\n[^1]: Note that this schema has been designed to validate all array elements, which requires the type definitions of the array elements to be scalar. See answer 1 to the question [\"How do I make a jsonschema so that it validates all objects in array?\"](https://stackoverflow.com/questions/49319692/how-do-i-make-a-jsonschema-so-that-it-validates-all-objects-in-array) on Stack Overflow for rationale.\n\n[^2]: The template contains a placeholder `id-of-option-1` for the option name in its `pros-and-cons-of-the-options` object. The JSON schema [contains an `additionalProperties` object](https://stackoverflow.com/a/62242833/873282) so that options pros and cons are validated properly.\n\n## Background information and tools\n\n* Homepage of the [ADR organization on GitHub](https://adr.github.io/)\n* [Markdown ADR (MADR)](https://adr.github.io/madr/) project with four variants of the [MADR template](https://github.com/adr/madr/tree/develop/template) versions (minimal and full, bare and commented with usage instructions) \u003c!-- note that the minimal template has not been ported to YAML/YADR yet. --\u003e\n* Olaf Zimmermann blogs about [architectural decision making and capturing](https://ozimmer.ch/tags/#architectural-decisions):\n  * Patterns and anti patterns for [ADR creation](https://ozimmer.ch/practices/2023/04/03/ADRCreation.html)\n  * Architectural decision making [fallacies and biases](https://ozimmer.ch/practices/2025/09/01/ADMFallacies.html)\n  * [\"The Markdown ADR (MADR) Template Explained and Distilled\"](https://ozimmer.ch/practices/2022/11/22/MADRTemplatePrimer.html)\n* YAML: [YAML homepage](https://yaml.org/), [YAML specification](https://yaml.org/spec/1.2.2/) and [YAML best practices](https://yamlscript.org/blog/2025-07-20/yaml-best-practices/)\n* One of many online [JSON schema validators](https://www.jsonschemavalidator.net/) and a sample [YAML to JSON converter](https://openreplay.com/tools/json-yaml/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadr%2Fyadr","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fadr%2Fyadr","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadr%2Fyadr/lists"}