{"repo":"adr/madr","free":true,"listed":false,"github":"https://github.com/adr/madr","clone":"git clone https://github.com/adr/madr.git","description":"Markdown Architectural Decision Records","language":"Markdown","stars":2406,"topics":["architectural-decisions","architectural-decision-records","documentation","design-document","design-documents","hacktoberfest"],"license":null,"category":"docs-static-sites","readme_excerpt":"Markdown Architectural Decision Records \"Markdown Architectural Decision Records\" (MADR) [ˈmæɾɚ] – decisions that [matter [ˈmæɾɚ] ](https://en.wiktionary.org/wiki/matter#Pronunciation). For user documentation, please head to . Quick start adr-template.md has all sections, with explanations about them. adr-template-minmal.md only contains mandatory sections, with explanations about them. adr-template-bare.md has all sections, which are empty (no explanations). adr-template-bare-minimal.md has the mandatory sections, without explanations. Copy it into docs/decisions . For each ADR, copy the template to nnnn-title.md and adapt. Longer explanation: Head to . Development hints MADR follows Semantic Versioning 2.0.0 and documents changes in a CHANGELOG.md following keep a changelog 1.0.0. Issues can be reported at . Suggestions can be contributed via pull requests. MADR offers pre-configured VS Code web environment at Gitpod. MADR uses markdownlint as Linter for Markdown files. Use markdownlint for checking for linting issues in VS Code. template/adr-template.md is mirrored to docs/decisions/adr-template . However, following YAML front matter is added to make it handled properly by the Just the Docs Jekyll Template. Branches Branch Meaning -------------- ---------------------------------------------------------------------------------------------------------------------------------------------- gh-pages Homepage showing the latest released version, rendered at develop Latest develo","default_branch":null,"files":null,"tree":[],"storefront":"/r/adr","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/adr/madr/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}