2022-01-13 15:24:55 +03:00
|
|
|
# Architectural Decision Records
|
|
|
|
|
|
|
|
|
|
This directory contains a series of [Architectural Decision Records](https://adr.github.io/)
|
|
|
|
|
or "ADRs" for the `swc` project. We're going to try to use it as a kind of collective
|
|
|
|
|
memory of the decisions we've made and the path we've taken to get the project to its current
|
|
|
|
|
point.
|
|
|
|
|
|
2022-05-04 17:25:28 +03:00
|
|
|
Note that these are _historical references_ that do not supersede (but might enhance) the living
|
2022-01-13 15:24:55 +03:00
|
|
|
documentation of the project itself, which you can find inline in the source code.
|
|
|
|
|
|
|
|
|
|
Proposing a non-trivial change to the way `swc` works? You might like to start with an ADR
|
|
|
|
|
by copying `template.md` into a new file, filling out a first version of the proposal, and
|
2022-05-04 17:25:28 +03:00
|
|
|
posting it as a PR on the github repo for discussion.
|
