Skip to content

Commit e7d46cf

Browse files
committed
Fix README & template to match parser
Fix the examples in the template to match the form actually needed by the parser, and remove the invalid `Proposed` status. Document the flow for new ADRs starting in `Accepted` status, to reflect that as soon as they've been merged they are Accepted.
1 parent 7cfc439 commit e7d46cf

File tree

3 files changed

+5
-1
lines changed

3 files changed

+5
-1
lines changed

.readme.templ

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ Please see the [template](adr-template.md). The template body is a guideline. Fe
2929

3030
After editing / adding a ADR please run `go run main.go > README.md` to update the embedded index. This will also validate the header part of your ADR.
3131

32+
Note that new ADRs are written with an initial state of `Accepted`, not `Proposed`, on the basis that once merged to `main` it is immediately Accepted.
33+
3234
## Related Repositories
3335

3436
* Server [nats-server](https://github.com/nats-io/nats-server)

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,8 @@ Please see the [template](adr-template.md). The template body is a guideline. Fe
100100

101101
After editing / adding a ADR please run `go run main.go > README.md` to update the embedded index. This will also validate the header part of your ADR.
102102

103+
Note that new ADRs are written with an initial state of `Accepted`, not `Proposed`, on the basis that once merged to `main` it is immediately Accepted.
104+
103105
## Related Repositories
104106

105107
* Server [nats-server](https://github.com/nats-io/nats-server)

adr-template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
|--------|-----|
55
|Date |YYYY-MM-DD|
66
|Author |@<github user>, @<github user>|
7-
|Status |`Proposed`, `Approved` `Partially Implemented`, `Implemented`|
7+
|Status |Approved, Partially Implemented, Implemented|
88
|Tags |jetstream, client, server|
99

1010
## Context and Problem Statement

0 commit comments

Comments
 (0)