-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: R.I.Pienaar <[email protected]>
- Loading branch information
Showing
11 changed files
with
1 addition
and
1,024 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,21 +1,3 @@ | ||
# Architecture Decision Records | ||
|
||
The directory [adr](adr) hold Architecture Decision Records that document major decisions made | ||
in the design of the NATS Server. | ||
|
||
A good intro to ADRs can be found in [Documenting Architecture Decisions](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions) by Michael Nygard. | ||
|
||
## When to write an ADR | ||
|
||
Not every little decision needs an ADR, and we are not overly prescriptive about the format. | ||
The kind of change that should have an ADR are ones likely to impact many client libraries | ||
or those where we specifically wish to solicit wider community input. | ||
|
||
## Format | ||
|
||
The [adr-tools](https://github.com/npryce/adr-tools) utility ships with a template that's a | ||
good starting point. We do not have a fixed format at present. | ||
|
||
## ADR Statuses | ||
|
||
Each ADR has a status, let's try to use `Proposed`, `Approved` `Partially Implemented`, `Implemented` and `Rejected`. | ||
The NATS ADR documents have moved to their [own repository](https://github.com/nats-io/nats-architecture-and-design/) |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.