Skip to content

Commit cdb1057

Browse files
authored
Fix templates (#157)
1 parent d376c6f commit cdb1057

File tree

3 files changed

+9
-9
lines changed

3 files changed

+9
-9
lines changed

docs/decisions/0001-use-CC0-or-MIT-as-license.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,25 +23,25 @@ We want to have MADR used without any hassle and that users can just go ahead an
2323

2424
## Decision Outcome
2525

26-
Chosen option: "Dual license", because this lets users choose whether CC0 or MIT fits better on their work.
26+
Chosen option: "Dual license with MIT and CC0", because this lets users choose whether CC0 or MIT fits better on their work.
2727

2828
## Pros and Cons of the Options
2929

30-
## CC0
30+
### CC0
3131

3232
* Good, because this license donates the content to "public domain" and does so as legally as possible.
3333
* Bad, because it does not contain attribution - and [attribution is important](https://opensource.stackexchange.com/a/9126/5671).
3434

35-
## BSD3
35+
### BSD3
3636

3737
* Bad, because it [is unclear whether it can be used for documentation](https://opensource.stackexchange.com/a/9545/5671)
3838

39-
## MIT
39+
### MIT
4040

4141
* Good, because it [explicitly may be used for documentation](https://opensource.stackexchange.com/a/9545/5671)
4242
* Good, because it is lean.
4343

44-
## Dual license with MIT and CC0
44+
### Dual license with MIT and CC0
4545

4646
With the SPDX identifier `MIT OR CC0-1.0`, the receiver of the documents can decide which license thay want to use.
4747

docs/decisions/0012-use-curly-braces-to-denote-placeholder.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ Idea taken from <https://github.com/schubmat/DecisionCapture/blob/master/templat
5252

5353
### Use HTML comments
5454

55-
Example: `<!-- option 1 -->
55+
Example: `<!-- option 1 -->`.
5656

5757
* Good, because feels "natural" in direct Markdown editing
5858
* Bad, because it does not render in HTML

docs/decisions/0013-use-yaml-front-matter-for-meta-data.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Chosen option: "Use YAML front matter", because comes out best (see below).
2626

2727
## Pros and Cons of the Options
2828

29-
## Use YAML front matter
29+
### Use YAML front matter
3030

3131
Example:
3232

@@ -37,7 +37,7 @@ decision-makers:
3737
date:
3838
---
3939

40-
## Context and problem statement
40+
### Context and problem statement
4141

4242
We want to record architectural decisions made in this project.
4343
Which format and structure should these records follow?
@@ -54,7 +54,7 @@ Rendered output:
5454
* Bad, because rendering not standardized
5555
* Bad, because not all Markdown parsers can parse it
5656

57-
## Use plain Markdown everywhere
57+
### Use plain Markdown everywhere
5858

5959
* Good, because all parsers can handle it
6060
* Bad, because special markdown parsing tooling is needed

0 commit comments

Comments
 (0)