Skip to content
This repository was archived by the owner on Oct 11, 2021. It is now read-only.

adr: reorganize ADR template#469

Merged
redeboer merged 4 commits intomasterfrom
adr-template
Feb 1, 2021
Merged

adr: reorganize ADR template#469
redeboer merged 4 commits intomasterfrom
adr-template

Conversation

@redeboer
Copy link
Copy Markdown
Member

@redeboer redeboer commented Feb 1, 2021

The sections of the ADR template has been reorganized as to agree more with upcoming ADRs #458 #461 #467. The idea is that an ADR becomes a bit more like an analysis: state the problem, list requirements of a possible solution, propose some solution, evaluate, and decide which solution to follow.

@redeboer redeboer added 📝 Docs Improvements or additions to documentation 🖱️ DX Improvements to the Developer Experience labels Feb 1, 2021
@redeboer redeboer requested a review from spflueger February 1, 2021 11:00
@redeboer redeboer self-assigned this Feb 1, 2021
docs/adr/001.md Outdated
intensity.

## Decision Drivers
## Decision drivers
Copy link
Copy Markdown
Member Author

@redeboer redeboer Feb 1, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note the style change: titles are not capitalized anymore to avoid problems in the sidebar:
image

This could be read as:

  • Context and Problem
  • Statement
  • ...

@codecov
Copy link
Copy Markdown

codecov bot commented Feb 1, 2021

Codecov Report

Merging #469 (5429fc5) into master (4288911) will increase coverage by 0.06%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #469      +/-   ##
==========================================
+ Coverage   89.94%   90.00%   +0.06%     
==========================================
  Files          22       22              
  Lines        3333     3333              
  Branches      833      833              
==========================================
+ Hits         2998     3000       +2     
+ Misses        173      172       -1     
+ Partials      162      161       -1     
Flag Coverage Δ
unittests 90.00% <ø> (+0.06%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
src/expertsystem/amplitude/helicity_decay.py 90.19% <0.00%> (+0.78%) ⬆️

@redeboer redeboer merged commit c104ed1 into master Feb 1, 2021
@redeboer redeboer deleted the adr-template branch February 1, 2021 11:54
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

📝 Docs Improvements or additions to documentation 🖱️ DX Improvements to the Developer Experience

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants