This file is a repository to capture concrete decisions that have to be made in order to implement the specs found in this repo. The idea here is that we have a record of extra decisions which are outside of the scope of the formal spec.
When such a case is found a section should be added to this document outlining the decision made and the section of the spec or rule that the decision corresponds to. In a specific format:
The format is similar to the Architectural Decision Record 1 used in issues in the wallet. This consists of:
This file should be edited by adding a section matching the format above in a PR against this repo. The PR should reference and issues in the implementation repo.
After that there are a few options:
THe proposal becomes the choice for concrete implementations henceforth. The PR is approved and merged
This refinement is discused in the PR proposing the decision, the section is ammended until we agree on the decision (this should be timeboxed) as we can always revisit any decisions.
This is the section that should be appended to when decisions are made
| Number | Base |
|---|---|
| https://github.com/some/other-repo/issues/14 | develop |
| #42 | release/2.0.0 |