Skip to content
This repository has been archived by the owner on Apr 13, 2022. It is now read-only.

Commit

Permalink
remove proposed and rejected statuses
Browse files Browse the repository at this point in the history
  • Loading branch information
keremciu committed Apr 14, 2021
1 parent baff77d commit b364efc
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 12 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,16 +41,16 @@ USAGE
$ adr-tool create [TITLE]
OPTIONS
-h, --help show CLI help
-t, --ticket=ticket technical ticket
--status=proposed|rejected|accepted|deprecated|superseeded
-h, --help show CLI help
-t, --ticket=ticket technical ticket
--status=accepted|deprecated|superseeded
EXAMPLE
$ adr-tool create use-adr-tool
$ adr-tool create 'Use ADR Tool'
a decision created on ./docs/adr/0001-use-adr-tool.md
```

_See code: [src/commands/create.ts](https://github.com/keremciu/adr-tool/blob/v0.0.6/src/commands/create.ts)_
_See code: [src/commands/create.ts](https://github.com/keremciu/adr-tool/blob/v0.0.7/src/commands/create.ts)_

## `adr-tool help [COMMAND]`

Expand Down Expand Up @@ -85,7 +85,7 @@ EXAMPLE
./docs/adr folder is created!
```

_See code: [src/commands/init.ts](https://github.com/keremciu/adr-tool/blob/v0.0.6/src/commands/init.ts)_
_See code: [src/commands/init.ts](https://github.com/keremciu/adr-tool/blob/v0.0.7/src/commands/init.ts)_

## `adr-tool toc`

Expand All @@ -103,5 +103,5 @@ EXAMPLE
./docs/adr/README.md file is created!
```

_See code: [src/commands/toc.ts](https://github.com/keremciu/adr-tool/blob/v0.0.6/src/commands/toc.ts)_
_See code: [src/commands/toc.ts](https://github.com/keremciu/adr-tool/blob/v0.0.7/src/commands/toc.ts)_
<!-- commandsstop -->
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "adr-tool",
"description": "easy CLI for ADR docs",
"version": "0.0.6",
"version": "0.0.7",
"author": "Kerem Sevencan @keremciu",
"bin": {
"adr-tool": "./bin/run"
Expand Down
4 changes: 2 additions & 2 deletions src/commands/create.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,13 @@ function getLatestIndex(): number {
return decisionFiles.length
}

const statusOptions = ['proposed', 'rejected', 'accepted', 'deprecated', 'superseeded']
const statusOptions = ['accepted', 'deprecated', 'superseeded']

export default class Create extends Command {
static description = 'create a new decision and log it into docs/adr/README.md file'

static examples = [
`$ adr-tool create use-adr-tool
`$ adr-tool create 'Use ADR Tool'
a decision created on ./docs/adr/0001-use-adr-tool.md
`,
]
Expand Down
6 changes: 4 additions & 2 deletions templates/template.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# [short title of solved problem and solution]

* Status: [proposed | rejected | accepted | deprecated | … | superseded by [ADR-0005](0005-example.md)] <!-- optional -->
* Status: [accepted | deprecated | superseded by [ADR-0005](0005-example.md)] <!-- optional -->
* Deciders: [list everyone involved in the decision] <!-- optional -->
* Date: [YYYY-MM-DD when the decision was last updated] <!-- optional -->
* Template used: [MADR 3.0.0](https://adr.github.io/madr/) <!-- optional -->
Expand Down Expand Up @@ -70,4 +70,6 @@ Chosen option: "[option 1]", because [justification. e.g., only option, which me
## Links <!-- optional -->

* [Link type] [Link to ADR] <!-- example: Refined by [ADR-0005](0005-example.md) -->
*<!-- numbers of links can vary -->
*<!-- numbers of links can vary -->

<!-- markdownlint-disable-file MD013 -->

0 comments on commit b364efc

Please sign in to comment.