mirror of https://github.com/gogrlx/nats-server.git synced 2026-04-02 03:38:42 -07:00

Files

Alberto Ricart 92e00f2a40 Header ADR clarifications (#1528 )

* clarifications on the ADR. Go is non-standard, and it's formatting
rules, create formatting dependencies that are not part of the spec.
Also added simplified guidance of allowed characters to help those
having to implement it.

* clarified that http.Header in go internally uses textproto.MIMEHeader.

[ci skip]

2020-09-05 19:06:55 -05:00

adr

Header ADR clarifications (#1528 )

2020-09-05 19:06:55 -05:00

README.md

initial Architecture Decision Record

2020-05-19 14:27:45 -07:00

README.md

Architecture Decision Records

The directory 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 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 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 and Rejected.