You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -8,11 +8,11 @@ For user documentation, please head to <https://adr.github.io/madr/>.
8
8
9
9
*[`adr-template.md`](template/adr-template.md) has all sections, with explanations about them.
10
10
*[`adr-template-minmal.md`](template/adr-template-minimal.md) only contains mandatory sections, with explanations about them. <!-- ### Consequences also contained, though marked as "optional" -->
11
-
*[`adr-template-bare.md`](template/adr-template-bare.md) has all sections, wich are empty (no explanations).
11
+
*[`adr-template-bare.md`](template/adr-template-bare.md) has all sections, which are empty (no explanations).
12
12
*[`adr-template-bare-minimal.md`](template/adr-template-bare-minimal.md) has the mandatory sections, without explanations. <!-- ### Consequences also contained, though marked as "optional" -->
13
13
14
14
Copy it into `docs/decisions`.
15
-
For each ADR, copy the tempalte to `nnnn-title.md` and adapt.
15
+
For each ADR, copy the template to `nnnn-title.md` and adapt.
16
16
Longer explanation: Head to <https://adr.github.io/madr/#applying-madr-to-your-project>.
17
17
18
18
## Development hints
@@ -80,7 +80,7 @@ In case you get errors regarding `Gemfile.lock`, just delete `Gemfile.lock` and
80
80
2. Update the concrete decisions in `docs/decisions/*` with the new template.
81
81
3. Commit ("Update examples and decisions") and push. Possibly as pull request.
82
82
4. Adapt the version reference in `template/0000-use-markdown-architectural-decision-records.md`.
83
-
5. Update "template" files in in `docs/decisions`:
83
+
5. Update "template" files in `docs/decisions`:
84
84
* Copy `template/0000-use-markdown-architectural-decision-records.md` to `docs/decisions/0000-use-markdown-architectural-decision-records.md`.
85
85
* Adapt content of `docs/decisions/adr-template.md` based on `template/adr-template.md`.
86
86
Thereby, ensure that the YAML front matter in `docs/decisions/adr-template.md` is kept.
0 commit comments