{"id":37037034,"url":"https://github.com/robyvandamme/dotadr","last_synced_at":"2026-01-14T04:24:27.285Z","repository":{"id":311698824,"uuid":"1028751115","full_name":"robyvandamme/dotadr","owner":"robyvandamme","description":".NET tool to create Architectural Decision Records in .NET solutions","archived":false,"fork":false,"pushed_at":"2025-11-12T00:19:08.000Z","size":62,"stargazers_count":0,"open_issues_count":3,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-11-12T02:27:55.325Z","etag":null,"topics":["adr","architectural-decision-records","dotnet","dotnet-tool"],"latest_commit_sha":null,"homepage":"","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/robyvandamme.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"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-07-30T02:34:55.000Z","updated_at":"2025-11-12T00:19:10.000Z","dependencies_parsed_at":"2025-08-26T03:51:58.705Z","dependency_job_id":"e2148be9-9571-4f63-9f76-af8f8d14b2fd","html_url":"https://github.com/robyvandamme/dotadr","commit_stats":null,"previous_names":["robyvandamme/dotadr"],"tags_count":1,"template":false,"template_full_name":"robyvandamme/dotnet-start","purl":"pkg:github/robyvandamme/dotadr","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robyvandamme%2Fdotadr","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robyvandamme%2Fdotadr/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robyvandamme%2Fdotadr/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robyvandamme%2Fdotadr/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/robyvandamme","download_url":"https://codeload.github.com/robyvandamme/dotadr/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robyvandamme%2Fdotadr/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28409482,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-14T01:52:23.358Z","status":"online","status_checked_at":"2026-01-14T02:00:06.678Z","response_time":107,"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":["adr","architectural-decision-records","dotnet","dotnet-tool"],"created_at":"2026-01-14T04:24:26.663Z","updated_at":"2026-01-14T04:24:27.276Z","avatar_url":"https://github.com/robyvandamme.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# dotADR\n\n.NET tool to create [Architectural Decision Records](https://adr.github.io) in .NET solutions.\n\n[![Release](https://github.com/robyvandamme/dotadr/actions/workflows/release.yml/badge.svg)](https://github.com/robyvandamme/dotadr/actions/workflows/release.yml)\n[![NuGet Version](https://img.shields.io/nuget/v/dotADR?color=004D81)](https://www.nuget.org/packages/dotADR/)\n[![Pre-release](https://github.com/robyvandamme/dotadr/actions/workflows/pre-release.yml/badge.svg)](https://github.com/robyvandamme/dotadr/actions/workflows/pre-release.yml)\n\n## Install\n\n```shell\ndotnet tool install dotADR\n```\n## Features\n\n### Initialize the ADR Directory\n\nCreates the ADR directory, adds the default template and a first decision record to the directory, and saves the ADR directory to a `dotadr.json` file.\n\n```text\nDESCRIPTION:\nInitialize the ADR directory\n\nUSAGE:\n    dotnet dotadr init [OPTIONS]\n\nEXAMPLES:\n    dotnet dotadr init\n    dotnet dotadr init -d ./doc/arch/adr -o true\n    dotnet dotadr init --debug true --logfile log.txt\n\nOPTIONS:\n                       DEFAULT                                              \n    -h, --help                      Prints help information                 \n        --debug                     Enable debug logging for troubleshooting\n        --logfile                   The file to send the log output to      \n    -d, --directory    ./doc/adr    The directory to initialize             \n    -o, --overwrite    false        Whether to overwrite existing files     \n\n```\n\n### Add a New Decision Record\n\nAdds a new decision record in the configured ADR directory using the `template.md` template file.\n\n```text\nDESCRIPTION:\nAdd a new decision record\n\nUSAGE:\n    dotnet dotadr add [title] [OPTIONS]\n    dotnet dotadr new [title] [OPTIONS]\n\nEXAMPLES:\n    dotnet dotadr add \"Implement Circuit Breaker Pattern for External Service Calls\"\n    dotnet dotadr add \"Separate Read and Write Data Models\" -s 002\n    dotnet dotadr add \"Use Database Per Service Pattern\" --debug true --logfile log.txt\n    dotnet dotadr new \"Implement Request Rate Limiting\"\n\nARGUMENTS:\n    [title]    The title of the new decision record\n\nOPTIONS:\n    -h, --help          Prints help information                                      \n        --debug         Enable debug logging for troubleshooting                     \n        --logfile       The file to send the log output to                           \n    -s, --supersedes    The ID of the decision record this decision record supersedes\n\n```\n\n## The ADR Template\n\nThe default template is based on [Documenting Architecture Decisions](https://cognitect.com/blog/2011/11/15/documenting-architecture-decisions) and looks like this:\n\n```text\n# {{ID}} {{TITLE}}\n\n* Status: Draft\n* Date: {{DATE}} \n* Supersedes: {{SUPERSEDES}}\n\n## Context\n\n## Decision\n\n## Consequences\n\n```\n\nThe decision record that is added upon initialization looks like this:\n\n```markdown\n# 001 Use Architectural Decision Records\n\n* Status: Draft\n* Date: 2025-08-19\n\n## Context\n\n## Decision\n\n## Consequences\n\n```\nThe line containing the `{{SUPERSEDES}}` variable is removed unless the `--supersedes`option is provided.\n\n\n### Changing the Template\n\nFeel free to customize the template, but consider keeping the `Status` and `Supersedes` sections as-is to maintain full feature compatibility.\nYou can choose to not include a variable, in that case it is simply ignored.\n\n### Superseding a Decision Record\n\nIn order for the superseding functionality to work you will need to keep the `\"* Status: xxxx\"` and `\"* Supersedes: {{SUPERSEDES}}\"` sections in the template more or less intact.\n\n```shell\ndotnet dotadr add \"Superseding Decision Record\" -s 002\n```\n\nWhen a record supersedes another record:\n* In the new record the `{{SUPERSEDES}}` variable is replaced by a link to the superseded record.\n* In the superseded record \"* Status: [current status]\" is replaced by \"* Status: [current status] - Superseded by \" + a link to the new superseding decision record and the current date.\n\n#### Example\n\n```markdown\n* Supersedes: [002](002-the-superseded-decision.md)\n```\n\n```markdown\n* Status: Accepted - Superseded by [077](077-the-superseding-decision.md) 2025-08-21\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frobyvandamme%2Fdotadr","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frobyvandamme%2Fdotadr","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frobyvandamme%2Fdotadr/lists"}