-
-
Notifications
You must be signed in to change notification settings - Fork 121
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add ADR-0005 (and fix lint at other ADR)
- Loading branch information
Showing
3 changed files
with
49 additions
and
30 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| # Use pdflatex as default | ||
|
|
||
| ## Context and Problem Statement | ||
|
|
||
| Which latex compiler to use? | ||
|
|
||
| * pdflatex | ||
| * xelatex | ||
| * lualatex | ||
|
|
||
| ## Decision Outcome | ||
|
|
||
| Chosen option: "pdflatex", because compiles faster and correct ligatures are required at the final typesetting step only. | ||
|
|
||
| ### Positive Consequences | ||
|
|
||
| * Faster compile time | ||
|
|
||
| ### Negative Consequences | ||
|
|
||
| * Using lualatex just before publication might lead to a different layout and additional effort | ||
| * lualatex's power might not be used at all |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,75 +1,72 @@ | ||
| # [short title of solved problem and solution] | ||
|
|
||
| * Status: [accepted | superseeded by [ADR-0005](0005-example.md) | deprecated | ...] <!-- optional --> | ||
| * Status: [proposed | rejected | accepted | deprecated | … | superseded by [ADR-0005](0005-example.md)] <!-- optional --> | ||
| * Deciders: [list everyone involved in the decision] <!-- optional --> | ||
| * Date: [YYYY-MM-DD when the decision was last updated] <!-- optional --> | ||
|
|
||
| Technical Story: [description | ticket/issue URL] <!-- optional --> | ||
|
|
||
|
|
||
| ## Context and Problem Statement | ||
| [Describe the context and problem statement, e.g., in free form using two to three sentences. You may want to articulate the problem in form of a question.] | ||
|
|
||
| [Describe the context and problem statement, e.g., in free form using two to three sentences. You may want to articulate the problem in form of a question.] | ||
|
|
||
| ## Decision Drivers <!-- optional --> | ||
|
|
||
| * [driver 1, e.g., a force, facing concern, ...] | ||
| * [driver 2, e.g., a force, facing concern, ...] | ||
| * ... <!-- numbers of drivers can vary --> | ||
|
|
||
| * [driver 1, e.g., a force, facing concern, …] | ||
| * [driver 2, e.g., a force, facing concern, …] | ||
| * … <!-- numbers of drivers can vary --> | ||
|
|
||
| ## Considered Options | ||
|
|
||
| * [option 1] | ||
| * [option 2] | ||
| * [option 3] | ||
| * ... <!-- numbers of options can vary --> | ||
|
|
||
| * … <!-- numbers of options can vary --> | ||
|
|
||
| ## Decision Outcome | ||
|
|
||
| Chosen option: "[option 1]", because [justification. e.g., only option, which meets k.o. criterion decision driver | which resolves force force | ... | comes out best (see below)]. | ||
| Chosen option: "[option 1]", because [justification. e.g., only option, which meets k.o. criterion decision driver | which resolves force force | … | comes out best (see below)]. | ||
|
|
||
| ### Positive Consequences <!-- optional --> | ||
|
|
||
| Positive Consequences: <!-- optional --> | ||
| * [e.g., improvement of quality attribute satisfaction, follow-up decisions required, ...] | ||
| * ... | ||
| * [e.g., improvement of quality attribute satisfaction, follow-up decisions required, …] | ||
| * … | ||
|
|
||
| Negative consequences: <!-- optional --> | ||
| * [e.g., compromising quality attribute, follow-up decisions required, ...] | ||
| * ... | ||
| ### Negative Consequences <!-- optional --> | ||
|
|
||
| * [e.g., compromising quality attribute, follow-up decisions required, …] | ||
| * … | ||
|
|
||
| ## Pros and Cons of the Options <!-- optional --> | ||
|
|
||
| ### [option 1] | ||
|
|
||
| [example | description | pointer to more information | ...] <!-- optional --> | ||
| [example | description | pointer to more information | …] <!-- optional --> | ||
|
|
||
| * Good, because [argument a] | ||
| * Good, because [argument b] | ||
| * Bad, because [argument c] | ||
| * ... <!-- numbers of pros and cons can vary --> | ||
| * … <!-- numbers of pros and cons can vary --> | ||
|
|
||
| ### [option 2] | ||
|
|
||
| [example | description | pointer to more information | ...] <!-- optional --> | ||
| [example | description | pointer to more information | …] <!-- optional --> | ||
|
|
||
| * Good, because [argument a] | ||
| * Good, because [argument b] | ||
| * Bad, because [argument c] | ||
| * ... <!-- numbers of pros and cons can vary --> | ||
| * … <!-- numbers of pros and cons can vary --> | ||
|
|
||
| ### [option 3] | ||
|
|
||
| [example | description | pointer to more information | ...] <!-- optional --> | ||
| [example | description | pointer to more information | …] <!-- optional --> | ||
|
|
||
| * Good, because [argument a] | ||
| * Good, because [argument b] | ||
| * Bad, because [argument c] | ||
| * ... <!-- numbers of pros and cons can vary --> | ||
|
|
||
| * … <!-- numbers of pros and cons can vary --> | ||
|
|
||
| ## Links <!-- optional --> | ||
|
|
||
| * [Link type] [Link to ADR] <!-- example: Refined by [ADR-0005](0005-example.md) --> | ||
| * ... <!-- numbers of links can vary --> | ||
| * … <!-- numbers of links can vary --> |